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 #1953

Merged
merged 3 commits into from
Jul 17, 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:

Close: #1942

Special notes for your reviewer:

nil

Testing

nil

Release Notes

NONE

@BlackHole1 BlackHole1 requested a review from a team as a code owner July 11, 2024 03:09
Copy link
Member

@Juneezee Juneezee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. However, the documentation website https://cli.urfave.org/ is still built using the docs folder of v2-maint branch so this change won't be reflected on the website.

@dearchap @meatballhat Should we consider moving the publish job from v2-maint branch to main branch?

publish:
permissions:
contents: write
if: startswith(github.ref, 'refs/tags/')
name: publish
needs: [test-docs]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- run: make ensure-mkdocs
env:
FLAGS: --upgrade-pip
- run: make set-mkdocs-remote
env:
MKDOCS_REMOTE_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- run: make deploy-mkdocs

@abitrolly
Copy link
Contributor

@junezee you mean this one?

publish:
permissions:
contents: write
# TODO: switch once v3 is out of alpha {{
# if: startswith(github.ref, 'refs/tags/')
if: false
# }}
name: publish

@abitrolly
Copy link
Contributor

I would say, docs publishing needs a separate job, which will pull markup files from all branches. This way v2 docs will be maintained in v2-maint branch.

@BlackHole1
Copy link
Member Author

BlackHole1 commented Jul 11, 2024

Should we consider moving the publish job from v2-maint branch to main branch?

This may not be a good idea because the current main branch contains the documentation for v3, which is still in the alpha stage. If we change it to the main branch, the website will display the v3 documentation.

I think we can merge this PR first, as the current changes include docs/v3. I can submit another PR and point it to the v2-maint branch :)

@BlackHole1 BlackHole1 force-pushed the improve-docs branch 2 times, most recently from 85ac7ff to f89808d Compare July 11, 2024 12:47
Copy link
Member

@bartekpacia bartekpacia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for contributing! 🎉

Close: urfave#1942

Signed-off-by: Kevin Cui <bh@bugs.cc>
BlackHole1 and others added 2 commits July 16, 2024 18:03
Co-authored-by: Anatoli Babenia <anatoli@rainforce.org>
Co-authored-by: Anatoli Babenia <anatoli@rainforce.org>
@Juneezee Juneezee merged commit 127cf54 into urfave:main Jul 17, 2024
13 checks passed
@BlackHole1 BlackHole1 deleted the improve-docs branch July 17, 2024 23:37
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.

BoolFlag Count and/or compound not working
6 participants