Improve documentation for most reporters #355
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds or updates documentation for all of the various options each reporter supports. Previously, quite a few options were undocumented. We're also now using Yard's `@option` tag more consistently (https://www.rubydoc.info/gems/yard/file/docs/Tags.md#option). This should improve how the docs look on rubydoc.info.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds or updates documentation for all of the various options each reporter supports. Previously, quite a few options were undocumented.
We're also now using Yard's
@optiontag more consistently (https://www.rubydoc.info/gems/yard/file/docs/Tags.md#option). This should improve how the docs look on rubydoc.info.