doc: add warning about Python argparse in flux-jobs(1) #6285
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: There's a quirk in the Python argparse implementation that causes a required option argument that has a leading dash to be ignored when a space between long option and its argument is used instead of an equals. This is common with the `flux jobs --since` option because relative FSD is allowed so `-1h`, `-30m`, etc are expected option arguments. This can be very confusing to users who may not have an inkling of what's going on. Add a note in the flux-jobs(1) man page regarding this quirk in hopes users will see and become aware of it. Suggest that `=` always be used between `--since` and its argument to avoid the problem.
grondo
force-pushed
the
doc-argparse-quirk
branch
from
d9905ae
to
0bc93e6
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #6285 +/- ##
==========================================
- Coverage 83.36% 83.35% -0.01%
==========================================
Files 522 522
Lines 85985 85985
==========================================
- Hits 71678 71673 -5
- Misses 14307 14312 +5 |
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: There's a quirk in the Python argparse implementation that causes a required option argument that has a leading dash to be ignored when a space between long option and its argument is used instead of an equals. This is common with the
flux jobs --sinceoption because relative FSD is allowed so-1h,-30m, etc are expected option arguments. This can be very confusing to users who may not have an inkling of what's going on.Add a note in the flux-jobs(1) man page regarding this quirk in hopes users will see and become aware of it. Suggest that
=always be used between--sinceand its argument to avoid the problem.