mirror of
https://github.com/nushell/nushell
synced 2025-01-16 07:04:09 +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
37 lines
1,012 B
Rust
37 lines
1,012 B
Rust
use crate::{update::Update, CustomValuePlugin};
|
|
use nu_plugin::{EngineInterface, EvaluatedCall, SimplePluginCommand};
|
|
use nu_protocol::{Category, LabeledError, Signature, SyntaxShape, Value};
|
|
|
|
pub struct UpdateArg;
|
|
|
|
impl SimplePluginCommand for UpdateArg {
|
|
type Plugin = CustomValuePlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"custom-value update-arg"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Updates a custom value as an argument"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.required(
|
|
"custom_value",
|
|
SyntaxShape::Any,
|
|
"the custom value to update",
|
|
)
|
|
.category(Category::Experimental)
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
plugin: &CustomValuePlugin,
|
|
engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
_input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
SimplePluginCommand::run(&Update, plugin, engine, call, &call.req(0)?)
|
|
}
|
|
}
|