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

Bugfix/consistent help formatting #166

Merged
merged 8 commits into from
May 6, 2024
Merged

Conversation

BrianPugh
Copy link
Owner

@BrianPugh BrianPugh commented Apr 30, 2024

Features

  • Added a new App.help_format type, "rich", which renders rich markup.

Bug Fixes

Compromises

  • In the help-page, added components to Parameters' help like [required: True] will no longer be stylized in markdown and restructuredtext formatted help pages.

@BrianPugh BrianPugh force-pushed the bugfix/consistent-help-formatting branch from 71ae7ea to 8dd9203 Compare May 1, 2024 03:47
@BrianPugh BrianPugh force-pushed the bugfix/consistent-help-formatting branch from cb69b76 to aeb754a Compare May 2, 2024 03:07
@BrianPugh BrianPugh marked this pull request as ready for review May 2, 2024 04:16
@codecov-commenter
Copy link

codecov-commenter commented May 2, 2024

Codecov Report

Attention: Patch coverage is 93.10345% with 6 lines in your changes are missing coverage. Please review.

Project coverage is 96.40%. Comparing base (7aafc8e) to head (444439e).

Files Patch % Lines
cyclopts/help.py 94.59% 2 Missing and 2 partials ⚠️
cyclopts/core.py 84.61% 2 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #166      +/-   ##
==========================================
+ Coverage   96.25%   96.40%   +0.15%     
==========================================
  Files          16       16              
  Lines        1815     1864      +49     
  Branches      457      468      +11     
==========================================
+ Hits         1747     1797      +50     
+ Misses         31       29       -2     
- Partials       37       38       +1     
Flag Coverage Δ
unittests 96.19% <93.10%> (+0.15%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@BrianPugh
Copy link
Owner Author

@OrHayat could you give this branch a test and see if it resolves your issues from #113? Thanks!

@BrianPugh BrianPugh merged commit 1f5e3d6 into main May 6, 2024
15 checks passed
@BrianPugh BrianPugh deleted the bugfix/consistent-help-formatting branch May 6, 2024 18:30
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.

None yet

2 participants