forked from extern/nushell
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
43 lines
1.1 KiB
Rust
43 lines
1.1 KiB
Rust
use nu_plugin::{EngineInterface, EvaluatedCall, PluginCommand};
|
|
use nu_protocol::{Category, LabeledError, PipelineData, Signature, Type, Value};
|
|
|
|
use crate::PolarsPlugin;
|
|
|
|
#[derive(Clone)]
|
|
pub struct PolarsCmd;
|
|
|
|
impl PluginCommand for PolarsCmd {
|
|
type Plugin = PolarsPlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"polars"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Operate with data in a dataframe format."
|
|
}
|
|
|
|
fn signature(&self) -> nu_protocol::Signature {
|
|
Signature::build("polars")
|
|
.category(Category::Custom("dataframe".into()))
|
|
.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,
|
|
_plugin: &Self::Plugin,
|
|
engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, LabeledError> {
|
|
Ok(PipelineData::Value(
|
|
Value::string(engine.get_help()?, call.head),
|
|
None,
|
|
))
|
|
}
|
|
}
|