docs: relocate Resque config option comments to render in Yard docs #834
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As formatted markdown comments on the class, the information is made visible in the Yard-generated docs without making the options appear to be class or instance variables. Possibly instrumentation READMEs could link in the Usage section to the instrumentation's latest version at rubydoc.info (for example, this here resque) to avoid repeating the details of config options in the README but still making the options discoverable from there.
Placing all this on the Instrumentation class is in contrast to the approach used in #824 where each option has a distinct comment.
Advantages to class-level doc comment:
Instrumentation
within the documentation.OTel::Inst::Resque
) with a single line while the doc content still lives close(ish) to the option declarations.Disadvantages to class-level doc comment:
Screenshots!
... and scroll down a bit ...