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

✨ Add support for rich_help_panel of commands in generated docs #828

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

kinuax
Copy link

@kinuax kinuax commented May 9, 2024

The generated Markdown docs ignore the division given by rich_help_panel while listing the commands. This is a proposal to support it.

@kinuax kinuax marked this pull request as draft May 9, 2024 21:03
@kinuax
Copy link
Author

kinuax commented May 10, 2024

I added the tests to verify the cases with default (None, "", "Commands") and custom panel titles. All format, linting, and tests pass locally on 3.11. CI only breaks on 3.7 with a syntax error due to the walrus operator (introduced on 3.8). Having that Python 3.7's end of life was almost a year ago and that click dropped 3.7 support 9 months ago, I wonder if this is a good moment to drop its support as well, I can take care of that before considering these changes.

@kinuax kinuax marked this pull request as ready for review May 10, 2024 13:34
@svlandeg svlandeg added feature New feature, enhancement or request p3 labels May 13, 2024
@kinuax kinuax changed the title Add support for rich_help_panel of commands in generated docs ✨ Add support for rich_help_panel of commands in generated docs May 13, 2024
@kinuax
Copy link
Author

kinuax commented May 17, 2024

As clarified at #830, click still supports 3.7 so I have refactored to avoid assignment expressions and pass 3.7 tests. Tests are updated too to verify mixed commands in same app and pass coverage. Ready to be reviewed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature, enhancement or request p3
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants