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

Uniformize usage() and extra_usage() message ending for commands helper. #8268

Merged
merged 1 commit into from
Mar 1, 2023

Conversation

jaudiger
Copy link
Contributor

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 style
  • cargo test --workspace to check that all tests pass

After 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.

@codecov
Copy link

codecov bot commented Feb 28, 2023

Codecov Report

Merging #8268 (11ac5ef) into main (ffc3727) will decrease coverage by 0.38%.
The diff coverage is 100.00%.

Additional details and impacted files

Impacted file tree graph

@@            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     
Impacted Files Coverage Δ
crates/nu-cli/src/print.rs 100.00% <100.00%> (ø)
crates/nu-cmd-lang/src/core_commands/alias.rs 100.00% <100.00%> (ø)
crates/nu-cmd-lang/src/core_commands/break_.rs 100.00% <100.00%> (ø)
...rates/nu-cmd-lang/src/core_commands/commandline.rs 54.68% <100.00%> (ø)
crates/nu-cmd-lang/src/core_commands/continue_.rs 100.00% <100.00%> (ø)
crates/nu-cmd-lang/src/core_commands/def.rs 100.00% <100.00%> (ø)
crates/nu-cmd-lang/src/core_commands/def_env.rs 100.00% <100.00%> (ø)
crates/nu-cmd-lang/src/core_commands/do_.rs 95.27% <100.00%> (ø)
...ates/nu-cmd-lang/src/core_commands/export_alias.rs 79.54% <100.00%> (ø)
crates/nu-cmd-lang/src/core_commands/export_def.rs 78.04% <100.00%> (ø)
... and 174 more

Copy link
Member

@sholderbach sholderbach left a 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.

@jaudiger
Copy link
Contributor Author

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.

@fdncred
Copy link
Collaborator

fdncred commented Feb 28, 2023

wow! what a pain to do all this. thanks so much!

Copy link
Contributor

@rgwood rgwood left a 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.

@rgwood rgwood merged commit a5c604c into nushell:main Mar 1, 2023
drbrain added a commit to drbrain/nushell that referenced this pull request Dec 10, 2023
Add a test to ensure that commands won't regress

Part of nushell#5066

See also nushell#8268
drbrain added a commit to drbrain/nushell that referenced this pull request Dec 10, 2023
Add a test to ensure that commands won't regress

Part of nushell#5066

See also nushell#8268
fdncred pushed a commit that referenced this pull request Dec 10, 2023
# 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
hardfau1t pushed a commit to hardfau1t/nushell that referenced this pull request Dec 14, 2023
…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
dmatos2012 pushed a commit to dmatos2012/nushell that referenced this pull request Feb 20, 2024
…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
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

4 participants