doc: improve --include documentation in flux-resource(1)
#6459
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
Problem: The flux-resource(1) documentation of the `-i, --include` option doesn't include the word "node", which made is less likely the option would pop up for a search on how to filter nodes in the output of various subcommands. Include "node" in the description of the `-i, --include` option. Make the text for all instances of the `--include` option the same.
grondo
force-pushed
the
resource-list-doc
branch
from
d7797ee
to
640631e
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #6459 +/- ##
==========================================
- Coverage 83.63% 83.62% -0.02%
==========================================
Files 523 523
Lines 87538 87538
==========================================
- Hits 73209 73200 -9
- Misses 14329 14338 +9
|
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.
@schoate had pointed out that the
flux resource list --includeoption is difficult to discover because the option name itself isn't exactly obvious and the man page description of the option doesn't include the term "node' (only host and rank).Update the
-i, --includeoption documentation to include the word "node" for improved search.