Support YARD's experimental type parser by removing "optional" from type descriptions
kaylareopelle opened this issue · 1 comments
In #1517 (comment), @olleolleolle brought to our attention the YARD experimental type parser does not support [optional Type]
argument descriptions in the documentation. One suggested alternative approach is to include the word optional
in the description of the argument. This pattern is common in the opentelemetry-ruby repo.
Here's one place where the [optional Type]
pattern is used:
opentelemetry-ruby/api/lib/opentelemetry/baggage.rb
Lines 27 to 29 in a9bcbda
Let's revisit our pattern for declaring optional types and determine if we want to adopt a change that supports YARD's type parser.
👋 This issue has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the keep
label to hold stale off permanently, or do nothing. If you do nothing this issue will be closed eventually by the stale bot.