-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Uniformize usage() and extra_usage() message ending for commands helper. #8268
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #8268 +/- ##
==========================================
- Coverage 68.10% 67.72% -0.38%
==========================================
Files 621 621
Lines 99312 99312
==========================================
- Hits 67635 67262 -373
- Misses 31677 32050 +373
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for doing the tedious work! Much nicer for the written documentation on the website and in the help. Only downside would be that it requires an additional character column in the completion menu when showing the description.
I’m opened to any suggestions. If you have something in mind that could help to uniformize the descriptions while also resolving the issue you mentioned with the column, please let me know. |
wow! what a pain to do all this. thanks so much! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! It's nice to be consistent about this kind of thing.
I don't think the extra character in the completion menu is a deal-breaker.
Add a test to ensure that commands won't regress Part of nushell#5066 See also nushell#8268
Add a test to ensure that commands won't regress Part of nushell#5066 See also nushell#8268
# Description This repeats #8268 to make all command usage strings start with an uppercase letter and end with a period per #5056 Adds a test to ensure that commands won't regress Part of #5066 # User-Facing Changes Command usage is now consistent # Tests + Formatting - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib` # After Submitting Automatic documentation updates
…1278) # Description This repeats nushell#8268 to make all command usage strings start with an uppercase letter and end with a period per nushell#5056 Adds a test to ensure that commands won't regress Part of nushell#5066 # User-Facing Changes Command usage is now consistent # Tests + Formatting - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib` # After Submitting Automatic documentation updates
…1278) # Description This repeats nushell#8268 to make all command usage strings start with an uppercase letter and end with a period per nushell#5056 Adds a test to ensure that commands won't regress Part of nushell#5066 # User-Facing Changes Command usage is now consistent # Tests + Formatting - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib` # After Submitting Automatic documentation updates
Description
Working on uniformizing the ending messages regarding methods usage() and extra_usage(). This is related to the issue #5066 after discussing it with @jntrnr
User-Facing Changes
None.
Tests + Formatting
Don't forget to add tests that cover your changes.
Make sure you've run and fixed any issues with these commands:
cargo fmt --all -- --check
to check standard code formatting (cargo fmt --all
applies these changes)cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect
to check that you're using the standard code stylecargo test --workspace
to check that all tests passAfter Submitting
If your PR had any user-facing changes, update the documentation after the PR is merged, if necessary. This will help us keep the docs up to date.