1
0
mirror of https://github.com/nushell/nushell.git synced 2025-01-09 07:48:14 +01:00
nushell/crates/nu-engine
Stefan Holderbach 95b78eee25
Change the usage misnomer to "description" ()
# Description
    
The meaning of the word usage is specific to describing how a command
function is *used* and not a synonym for general description. Usage can
be used to describe the SYNOPSIS or EXAMPLES sections of a man page
where the permitted argument combinations are shown or example *uses*
are given.
Let's not confuse people and call it what it is a description.

Our `help` command already creates its own *Usage* section based on the
available arguments and doesn't refer to the description with usage.

# User-Facing Changes

`help commands` and `scope commands` will now use `description` or
`extra_description`
`usage`-> `description`
`extra_usage` -> `extra_description`

Breaking change in the plugin protocol:

In the signature record communicated with the engine.
`usage`-> `description`
`extra_usage` -> `extra_description`

The same rename also takes place for the methods on
`SimplePluginCommand` and `PluginCommand`

# Tests + Formatting
- Updated plugin protocol specific changes
# After Submitting
- [ ] update plugin protocol doc
2024-08-22 12:02:08 +02:00
..
src Change the usage misnomer to "description" () 2024-08-22 12:02:08 +02:00
Cargo.toml Bump version to 0.97.2 () 2024-08-22 11:36:32 +02:00
LICENSE Fix rest of license year ranges () 2023-04-04 09:03:29 +12:00
README.md Add top-level crate documentation/READMEs () 2024-07-14 10:10:41 +02:00

This crate primarily drives the evaluation of expressions.

(Some overlap with nu-protocol)

  • Provides CallExt

Internal Nushell crate

This crate implements components of Nushell and is not designed to support plugin authors or other users directly.