mirror of
https://github.com/nushell/nushell.git
synced 2025-02-16 10:32:29 +01:00
95b78eee25
# 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
|
||
|---|---|---|
| .. | ||
| mod.rs | ||
| test_bits.rs | ||
| test_cell_path.rs | ||
| test_commandline.rs | ||
| test_conditionals.rs | ||
| test_config_path.rs | ||
| test_config.rs | ||
| test_converters.rs | ||
| test_custom_commands.rs | ||
| test_engine.rs | ||
| test_env.rs | ||
| test_help.rs | ||
| test_hiding.rs | ||
| test_ide.rs | ||
| test_iteration.rs | ||
| test_known_external.rs | ||
| test_math.rs | ||
| test_modules.rs | ||
| test_parser.rs | ||
| test_ranges.rs | ||
| test_regex.rs | ||
| test_signatures.rs | ||
| test_spread.rs | ||
| test_stdlib.rs | ||
| test_strings.rs | ||
| test_table_operations.rs | ||
| test_type_check.rs | ||
| tests.rs | ||