Fix command descriptions+examples (#5129)

* Fix exit usage

* Move dfr as-date* format examples to extra_usage

* Update command usage and examples

* More docs on `str trim`

Co-authored-by: sholderbach <sholderbach@users.noreply.github.com>
This commit is contained in:
Reilly Wood
2022-04-08 01:30:49 -07:00
committed by GitHub
parent 6b4cb8b0e0
commit d38a3a8b4e
39 changed files with 104 additions and 62 deletions

View File

@ -18,13 +18,13 @@ impl Command for SubCommand {
.rest(
"column path",
SyntaxShape::CellPath,
"optionally, remove ansi sequences by column paths",
"optionally, remove ANSI sequences by column paths",
)
.category(Category::Platform)
}
fn usage(&self) -> &str {
"strip ansi escape sequences from string"
"Strip ANSI escape sequences from a string"
}
fn run(
@ -39,7 +39,7 @@ impl Command for SubCommand {
fn examples(&self) -> Vec<Example> {
vec![Example {
description: "strip ansi escape sequences from string",
description: "Strip ANSI escape sequences from a string",
example: r#"echo [ (ansi green) (ansi cursor_on) "hello" ] | str collect | ansi strip"#,
result: Some(Value::test_string("hello")),
}]