mirror of
https://github.com/nushell/nushell.git
synced 2025-05-11 02:12:58 +00: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
48 lines
1.1 KiB
Rust
48 lines
1.1 KiB
Rust
use nu_plugin::{EngineInterface, EvaluatedCall, SimplePluginCommand};
|
|
use nu_protocol::{Category, LabeledError, Signature, Value};
|
|
|
|
use crate::ExamplePlugin;
|
|
|
|
pub struct Main;
|
|
|
|
impl SimplePluginCommand for Main {
|
|
type Plugin = ExamplePlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"example"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Example commands for Nushell plugins"
|
|
}
|
|
|
|
fn extra_description(&self) -> &str {
|
|
r#"
|
|
The `example` plugin demonstrates usage of the Nushell plugin API.
|
|
|
|
Several commands provided to test and demonstrate different capabilities of
|
|
plugins exposed through the API. None of these commands are intended to be
|
|
particularly useful.
|
|
"#
|
|
.trim()
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name()).category(Category::Experimental)
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["example"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &Self::Plugin,
|
|
engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
_input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
Ok(Value::string(engine.get_help()?, call.head))
|
|
}
|
|
}
|