mirror of
https://github.com/nushell/nushell.git
synced 2025-04-29 15:44:28 +02: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
35 lines
910 B
Rust
35 lines
910 B
Rust
use nu_engine::{command_prelude::*, get_full_help};
|
|
|
|
#[derive(Clone)]
|
|
pub struct To;
|
|
|
|
impl Command for To {
|
|
fn name(&self) -> &str {
|
|
"to"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Translate structured data to a format."
|
|
}
|
|
|
|
fn signature(&self) -> nu_protocol::Signature {
|
|
Signature::build("to")
|
|
.category(Category::Formats)
|
|
.input_output_types(vec![(Type::Nothing, Type::String)])
|
|
}
|
|
|
|
fn extra_description(&self) -> &str {
|
|
"You must use one of the following subcommands. Using this command as-is will only produce this help message."
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
Ok(Value::string(get_full_help(self, engine_state, stack), call.head).into_pipeline_data())
|
|
}
|
|
}
|