Skip to content

docs(flag): add UseShortOptionHandling description - #1956

Merged
dearchap merged 3 commits into
urfave:v2-maintfrom
BlackHole1:improve-flags-docs
Aug 13, 2024
Merged

dearchap merged 3 commits into
urfave:v2-maintfrom
BlackHole1:improve-flags-docs

Conversation

@BlackHole1

Copy link
Copy Markdown
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

@BlackHole1
BlackHole1 requested a review from a team as a code owner July 18, 2024 01:39
@BlackHole1

Copy link
Copy Markdown
Member Author

CI Failed: Cannot use two forms of the same flag

@abitrolly Do you have any suggections?

@abitrolly

Copy link
Copy Markdown
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.

Comment thread docs/v2/examples/flags.md Outdated
@dearchap
dearchap merged commit 9114559 into urfave:v2-maint Aug 13, 2024
@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