mirror of
https://github.com/nushell/nushell.git
synced 2024-12-27 01:19:25 +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
|
||
|---|---|---|
| .. | ||
| src | ||
| Cargo.toml | ||
| README.md | ||
nu_plugin_formats
A nushell plugin to convert data to nushell tables.
support commands:
- from eml - original ported from nushell core.
- from ics - original ported from nushell core.
- from ini - original ported from nushell core.
- from vcf - original ported from nushell core.
Prerequisite
nushell, It's a nushell plugin, so you need it.
Usage
- compile the binary:
cargo build - plugin add plugin(assume it's compiled in ./target/debug/):
plugin add ./target/debug/nu_plugin_formats