nushell/crates/nu_plugin_query/src
Stefan Holderbach 95b78eee25
Change the usage misnomer to "description" (#13598)
# 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
..
lib.rs feat: add query webpage-info to plugin_nu_query (#13252) 2024-06-29 16:13:31 -05:00
main.rs Add support for engine calls from plugins (#12029) 2024-03-09 11:26:30 -06:00
query_json.rs Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
query_web.rs Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
query_webpage_info.rs Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
query_xml.rs Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
query.rs Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
web_tables.rs Include empty table data cells in query web tables (#13538) 2024-08-05 06:20:14 -05:00