mirror of
https://github.com/nushell/nushell.git
synced 2025-04-11 06:48:31 +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
114 lines
3.2 KiB
Rust
114 lines
3.2 KiB
Rust
use nu_engine::command_prelude::*;
|
|
|
|
#[derive(Clone)]
|
|
pub struct SubCommand;
|
|
|
|
impl Command for SubCommand {
|
|
fn name(&self) -> &str {
|
|
"math sin"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("math sin")
|
|
.switch("degrees", "Use degrees instead of radians", Some('d'))
|
|
.input_output_types(vec![
|
|
(Type::Number, Type::Float),
|
|
(
|
|
Type::List(Box::new(Type::Number)),
|
|
Type::List(Box::new(Type::Float)),
|
|
),
|
|
])
|
|
.category(Category::Math)
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Returns the sine of the number."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["trigonometry"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let head = call.head;
|
|
let use_degrees = call.has_flag(engine_state, stack, "degrees")?;
|
|
// This doesn't match explicit nulls
|
|
if matches!(input, PipelineData::Empty) {
|
|
return Err(ShellError::PipelineEmpty { dst_span: head });
|
|
}
|
|
input.map(
|
|
move |value| operate(value, head, use_degrees),
|
|
engine_state.signals(),
|
|
)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Apply the sine to π/2",
|
|
example: "3.141592 / 2 | math sin | math round --precision 4",
|
|
result: Some(Value::test_float(1f64)),
|
|
},
|
|
Example {
|
|
description: "Apply the sine to a list of angles in degrees",
|
|
example: "[0 90 180 270 360] | math sin -d | math round --precision 4",
|
|
result: Some(Value::list(
|
|
vec![
|
|
Value::test_float(0f64),
|
|
Value::test_float(1f64),
|
|
Value::test_float(0f64),
|
|
Value::test_float(-1f64),
|
|
Value::test_float(0f64),
|
|
],
|
|
Span::test_data(),
|
|
)),
|
|
},
|
|
]
|
|
}
|
|
}
|
|
|
|
fn operate(value: Value, head: Span, use_degrees: bool) -> Value {
|
|
match value {
|
|
numeric @ (Value::Int { .. } | Value::Float { .. }) => {
|
|
let span = numeric.span();
|
|
let (val, span) = match numeric {
|
|
Value::Int { val, .. } => (val as f64, span),
|
|
Value::Float { val, .. } => (val, span),
|
|
_ => unreachable!(),
|
|
};
|
|
|
|
let val = if use_degrees { val.to_radians() } else { val };
|
|
|
|
Value::float(val.sin(), span)
|
|
}
|
|
Value::Error { .. } => value,
|
|
other => Value::error(
|
|
ShellError::OnlySupportsThisInputType {
|
|
exp_input_type: "numeric".into(),
|
|
wrong_type: other.get_type().to_string(),
|
|
dst_span: head,
|
|
src_span: other.span(),
|
|
},
|
|
head,
|
|
),
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(SubCommand {})
|
|
}
|
|
}
|