gh-127296: Document that argparse count action starts from a non-zero default - #156908
Open
owenthcarey wants to merge 1 commit into
Open
gh-127296: Document that argparse count action starts from a non-zero default#156908owenthcarey wants to merge 1 commit into
owenthcarey wants to merge 1 commit into
Conversation
Documentation build overview
|
Comment on lines
838
to
+840
| Note, the *default* will be ``None`` unless explicitly set to *0*. | ||
| If the default value is a non-zero number, the count starts from that | ||
| number rather than from zero. |
Member
There was a problem hiding this comment.
Suggested change
| Note, the *default* will be ``None`` unless explicitly set to *0*. | |
| If the default value is a non-zero number, the count starts from that | |
| number rather than from zero. | |
| Unless explicitly set, the *default* will be ``None``. If the default | |
| value is a non-zero number, the count starts from that number rather | |
| than from zero. |
Minor tweak because I think the preceding sentence could also be worded better.
This file contains hidden or 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
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.
The
'count'action adds to whatever value is already in the namespace, so withdefault=3a single-vgives 4, not 1. The docs don't say this, and the general description ofdefaultreads as if the default is only used when the argument is absent.This adds one sentence to the
'count'entry saying that a non-zero default is the starting point for the count, as suggested in the issue.Fixes #127296