[docs] Small improvement to report --help
documentation
#19865
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.
When I started using the reports functionality, I found its
--help
documentation a bit confusing at first. This elaborates it a little bit to make it clear that the "DIR" is an output dir (and not, say, a source dir).I manually tested this to make sure the new help text was right. It does the obvious thing, indeed. Here is a diff:
Out of curiosity, I also manually tested what happens if you remove the metavar here. It displays long default metavars like SPECIAL-OPTS:HTML_REPORT, which is not helpful — so I didn't do that.