search

flux-framework / flux-core

core services for the Flux resource management framework
GNU Lesser General Public License v3.0
168 stars 50 forks source link

doc: improve `--include` documentation in flux-resource(1) #6459

Closed grondo closed 2 days ago

grondo commented 2 days ago

@schoate had pointed out that the flux resource list --include option 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, --include option documentation to include the word "node" for improved search.

codecov[bot] commented 2 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 83.62%. Comparing base (607c57e) to head (640631e). Report is 2 commits behind head on master.

Additional details and impacted files ```diff @@ 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 ``` [see 9 files with indirect coverage changes](https://app.codecov.io/gh/flux-framework/flux-core/pull/6459/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flux-framework)

🚨 Try these New Features: