doc: reword initial program environment section in flux-environment(7)
#6601
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 section of flux-environment(7) detailing the initial program environment can be confusing to users because the set of environment variables *not* set is prominently listed first in a nice bulleted list, while environment variable(s) that *are* set appear later in paragraph form. This may lead users that are casually scanning the document to assume that the listed environment variables will be found in the initial program environment. Swap the section so that the environment variables that are set and the suggested commands to obtain common values using Flux commands are listed first and add documentation to emphasize their importance. De-emphasize the unset variables by listing them in paragraph form instead of a bulleted list.
|
Thanks! I'll set MWP. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #6601 +/- ##
=======================================
Coverage 79.50% 79.51%
=======================================
Files 531 531
Lines 88213 88213
=======================================
+ Hits 70135 70143 +8
+ Misses 18078 18070 -8 |
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.
Problem: The section of flux-environment(7) detailing the initial program environment can be confusing to users because the set of environment variables not set is prominently listed first in a nice bulleted list, while environment variable(s) that are set appear later in paragraph form. This may lead users that are casually scanning the document to assume that the listed environment variables will be found in the initial program environment.
Swap the section so that the environment variables that are set and the suggested commands to obtain common values using Flux commands are listed first and add documentation to emphasize their importance.
De-emphasize the unset variables by listing them in paragraph form instead of a bulleted list.