Skip to content

Commit 97daf90

Browse files
committed
adds kramdown to dev dependencies
Yard's default use of the rdoc markdown provider was choking on links containing codeblocks, for example: [`ENV`](link/to/somewhere). These style links are pretty popular in the text details provided with semconv attributes. Let's switch to kramdown which is a markdown parser and renderer that: * can handle inline code blocks inside a link anchor * is pure Ruby (no C extensions) so works with JRuby
1 parent a641734 commit 97daf90

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

semantic_conventions/.yardopts

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
--no-private
22
--title=OpenTelemetry Semantic Conventions
33
--markup=markdown
4+
--markup-provider=kramdown
45
--main=README.md
56
./lib/opentelemetry/**/*.rb
67
-

semantic_conventions/opentelemetry-semantic_conventions.gemspec

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
3030
spec.add_development_dependency 'bundler', '>= 1.17'
3131
spec.add_development_dependency 'minitest', '~> 5.0'
3232
spec.add_development_dependency 'rake', '~> 12.0'
33+
spec.add_development_dependency 'kramdown', '~> 2.3'
3334
spec.add_development_dependency 'rubocop', '~> 1.3'
3435
spec.add_development_dependency 'simplecov', '~> 0.17'
3536
spec.add_development_dependency 'yard', '~> 0.9'

0 commit comments

Comments
 (0)