Repository navigation
docs: fix ErrHelpWanted / ErrVersionWanted description in Parse and ParseWithOptions doc comments - #60
Merged
Conversation
…seWithOptions` doc comments The doc comments for `Parse` and `ParseWithOptions` stated that `ErrHelpWanted` is returned for both `--help` and `--version`. In fact `--version` returns the separate `ErrVersionWanted` sentinel. Corrected both comments to match the switch in `ParseWithOptions`.
Collaborator
|
Thanks for the fixes |
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.
Summary
The doc comments on
ParseandParseWithOptionsclaimed thatErrHelpWantedis returned when either--helpor--versionis detected. That is inaccurate:ParseWithOptionsreturnsErrHelpWantedfor--helpand the distinctErrVersionWantedfor--version. This corrects both comments to reflect the actual control flow.Changes
Parsedoc comment: distinguishErrHelpWanted(--help) fromErrVersionWanted(--version).ParseWithOptionsdoc comment: same correction.Documentation only — no behavior change.