extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-07-02 23:51:49 +02:00
Code Issues Packages Projects Releases Wiki Activity

Further edits to help messages (#6913)

Browse Source
This commit is contained in:
Leon
2022-10-27 02:36:42 +10:00
committed by GitHub
parent 902aad6016
commit 5add5cbd12
34 changed files with 113 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
crates/nu-command/src/core_commands/echo.rs
View File

@ -2,7 +2,7 @@ use nu_engine::CallExt;
use nu_protocol::ast::Call;
use nu_protocol::engine::{Command, EngineState, Stack};
use nu_protocol::{
Category, Example, ListStream, PipelineData, ShellError, Signature, SyntaxShape, Value,
Category, Example, ListStream, PipelineData, ShellError, Signature, Span, SyntaxShape, Value,
};
#[derive(Clone)]
@ -14,7 +14,7 @@ impl Command for Echo {
}
fn usage(&self) -> &str {
"Echo the arguments back to the user."
"Returns its arguments, ignoring the piped-in value."
}
fn signature(&self) -> Signature {
@ -24,7 +24,9 @@ impl Command for Echo {
}
fn extra_usage(&self) -> &str {
"Unlike `print`, this command returns an actual value that will be passed to the next command of the pipeline."
r#"When given no arguments, it returns an empty string. When given one argument,
it returns it. Otherwise, it returns a list of the arguments. There is usually
little reason to use this over just writing the values as-is."#
}
fn run(
@ -61,13 +63,17 @@ impl Command for Echo {
fn examples(&self) -> Vec<Example> {
vec![
Example {
description: "Put a hello message in the pipeline",
example: "echo 'hello'",
result: Some(Value::test_string("hello")),
description: "Put a list of numbers in the pipeline. This is the same as [1 2 3].",
example: "echo 1 2 3",
result: Some(Value::List {
vals: vec![Value::test_int(1), Value::test_int(2), Value::test_int(3)],
span: Span::test_data(),
}),
},
Example {
description: "Print the value of the special '$nu' variable",
example: "echo $nu",
description:
"Returns the piped-in value, by using the special $in variable to obtain it.",
example: "echo $in",
result: None,
},
]