doc(cli): improve cli reference display #1853
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
noirbizarre
force-pushed
the
doc/tidy-cli-reference
branch
from
dc4513d to
04b7620
Compare
- fixes dunders being rendered as bold markdown - adds the missing spaces before `(default:` or `[env var` - monospace some known reccuring references (`pyproject.toml`, `pdm.lock`, `.pdm-python`, `:all`, `:pre` and `:post`) - apply the same casing to all help messages (Title) - use the same format for all env vars - use the same format (backticked) for parameters in help
noirbizarre
force-pushed
the
doc/tidy-cli-reference
branch
from
04b7620 to
6278b78
Compare
Codecov ReportPatch coverage:
📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more Additional details and impacted files@@ Coverage Diff @@
## main #1853 +/- ##
=======================================
Coverage 85.31% 85.32%
=======================================
Files 99 99
Lines 9037 9042 +5
Branches 1955 1955
=======================================
+ Hits 7710 7715 +5
Misses 896 896
Partials 431 431
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist
news/describing what is new (I don't think this requires a dedicated changelog entry, but if this is the case, I'll add it)Describe what you have changed in this PR.
Improve cli reference display by:
(default:or[env varpyproject.toml,pdm.lock,.pdm-python,:all,:preand:post)