-
-
Notifications
You must be signed in to change notification settings - Fork 289
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: remove description prefix from CLI options #6682
Merged
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
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## unstable #6682 +/- ##
=========================================
Coverage 61.80% 61.80%
=========================================
Files 556 556
Lines 59103 59103
Branches 1898 1898
=========================================
Hits 36526 36526
Misses 22534 22534
Partials 43 43 |
Performance Report✔️ no performance regression detected Full benchmark results
|
wemeetagain
approved these changes
Apr 18, 2024
twoeths
approved these changes
Apr 19, 2024
🎉 This PR is included in v1.18.0 🎉 |
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.
Motivation
It seems unnecessary that we prefix the description with
description:
, should be clear from context that this is the description of the CLI option, and I think it supports readability to remove it.With description:
Without description:
Description
Remove
description:
prefix from description of CLI options, for everything else the prefix adds important information.