minor man page improvements #6519
Merged
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
chu11
approved these changes
Dec 17, 2024
| @@ -440,6 +440,13 @@ plugins include: | |||
| takes place on all the job's nodes if the scope is local, versus only the | |||
| first node of the job if the scope is global. | |||
|
|
|||
| .. warning:: | |||
There was a problem hiding this comment.
commit message s/drived/drifted/ ?
garlick
force-pushed
the
doc_improvements
branch
from
c60192c to
7a58df2
Compare
|
Huh, this unit test failed on el8. I'll run it again but it's an odd one to fail. |
grondo
approved these changes
Dec 17, 2024
| of higher level commands such as :man1:`flux-submit`. | ||
| must also be set for the stream. | ||
|
|
||
| See also: :option:`flux-submit --output`, :option:`flux-submit --error`. |
|
Thanks guys - I'll set MWP |
Problem: a warning box intended to clarify a point about stage-in file paths has drifted away from the shell stage-in options. Move warning box back to its original location.
Problem: users may be unaware of the nicer flux-submit shorthands for shell options when perusing flux-shell(1). Add some explicit linked references and normalize the form of the references that already exist.
Problem: the environment available to prolog, epilog, and housekeeping scripts is not documented in the environment man page. Add a section.
garlick
force-pushed
the
doc_improvements
branch
from
7a58df2 to
95ed4fd
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #6519 +/- ##
==========================================
- Coverage 83.66% 83.61% -0.06%
==========================================
Files 522 522
Lines 87734 87734
==========================================
- Hits 73401 73356 -45
- Misses 14333 14378 +45 |
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.
Here are a few fixes to man page deficiencies that I noticed.