extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2024-11-07 09:04:18 +01:00
Code Issues Packages Projects Releases Wiki Activity
822007dbbb
nushell/crates/nu-plugin-test-support
History
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
..
src Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
tests Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
Cargo.toml Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
LICENSE Add test support crate for plugin developers (#12259) 2024-03-23 13:29:54 -05:00
README.md Add test support crate for plugin developers (#12259) 2024-03-23 13:29:54 -05:00

README.md

nu-plugin-test-support

This crate provides helpers for running tests on plugin commands, and is intended to be included in the dev-dependencies of plugin crates for testing.