Repository navigation
docs: describe positional argument types and accessors - #2532
Closed
Narek-Khachikyan wants to merge 1 commit into
Closed
Narek-Khachikyan wants to merge 1 commit into
Narek-Khachikyan wants to merge 1 commit into
Conversation
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.
What type of PR is this?
What this PR does / why we need it:
The positional argument API lacks GoDoc descriptions for its exported types and command accessors. Add comments describing their values and lookup behavior, and document the generic parsing methods. Regenerate
godoc-current.txtandtestdata/godoc-v3.x.txtas required by the contribution guide.Which issue(s) this PR fixes:
Fixes #2528
Testing
make generate,make v3approve,make v3diff,make vet, andmake testpass; the test target includes race detection. Confirmedgo doc StringArgdisplays the added description.Release Notes