Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(flag): add UseShortOptionHandling description #1956

Merged
merged 3 commits into from
Aug 13, 2024

Conversation

BlackHole1
Copy link
Member

What type of PR is this?

  • documentation

What this PR does / why we need it:

Add a description of UseShortOptionHandling in the Flag section so that users can clearly understand that to support Flags like -vvv, it is necessary to set UseShortOptionHandling.

Which issue(s) this PR fixes:

nil

Special notes for your reviewer:

Backport of #1953

Ref: #1953 (comment)

Testing

nil

Release Notes

NONE

/cc @Juneezee @dearchap

Signed-off-by: Kevin Cui <bh@bugs.cc>
@BlackHole1 BlackHole1 requested a review from a team as a code owner July 18, 2024 01:39
@BlackHole1
Copy link
Member Author

CI Failed: Cannot use two forms of the same flag

@abitrolly Do you have any suggections?

@abitrolly
Copy link
Contributor

@BlackHole1 looks like it doesn't work on v2, so the suggestion is to split examples into those that work and those that are don't. Maybe v2 fix is not feasible.

docs/v2/examples/flags.md Outdated Show resolved Hide resolved
@dearchap dearchap merged commit 9114559 into urfave:v2-maint Aug 13, 2024
11 checks passed
@BlackHole1 BlackHole1 deleted the improve-flags-docs branch August 13, 2024 01:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants