mirror of
https://github.com/nushell/nushell.git
synced 2025-05-20 01:40:47 +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
100 lines
2.7 KiB
Rust
100 lines
2.7 KiB
Rust
use crate::math::{
|
|
reducers::{reducer_for, Reduce},
|
|
utils::run_with_function,
|
|
};
|
|
use nu_engine::command_prelude::*;
|
|
|
|
#[derive(Clone)]
|
|
pub struct SubCommand;
|
|
|
|
impl Command for SubCommand {
|
|
fn name(&self) -> &str {
|
|
"math sum"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("math sum")
|
|
.input_output_types(vec![
|
|
(Type::List(Box::new(Type::Number)), Type::Number),
|
|
(Type::List(Box::new(Type::Duration)), Type::Duration),
|
|
(Type::List(Box::new(Type::Filesize)), Type::Filesize),
|
|
(Type::Range, Type::Number),
|
|
(Type::table(), Type::record()),
|
|
(Type::record(), Type::record()),
|
|
])
|
|
.allow_variants_without_examples(true)
|
|
.category(Category::Math)
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Returns the sum of a list of numbers or of each column in a table."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["plus", "add", "total", "+"]
|
|
}
|
|
|
|
fn is_const(&self) -> bool {
|
|
true
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
run_with_function(call, input, summation)
|
|
}
|
|
|
|
fn run_const(
|
|
&self,
|
|
_working_set: &StateWorkingSet,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
run_with_function(call, input, summation)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Sum a list of numbers",
|
|
example: "[1 2 3] | math sum",
|
|
result: Some(Value::test_int(6)),
|
|
},
|
|
Example {
|
|
description: "Get the disk usage for the current directory",
|
|
example: "ls | get size | math sum",
|
|
result: None,
|
|
},
|
|
Example {
|
|
description: "Compute the sum of each column in a table",
|
|
example: "[[a b]; [1 2] [3 4]] | math sum",
|
|
result: Some(Value::test_record(record! {
|
|
"a" => Value::test_int(4),
|
|
"b" => Value::test_int(6),
|
|
})),
|
|
},
|
|
]
|
|
}
|
|
}
|
|
|
|
pub fn summation(values: &[Value], span: Span, head: Span) -> Result<Value, ShellError> {
|
|
let sum_func = reducer_for(Reduce::Summation);
|
|
sum_func(Value::nothing(head), values.to_vec(), span, head)
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(SubCommand {})
|
|
}
|
|
}
|