holm/nushell
1
1
Fork 0
forked from extern/nushell
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve uniq documentation (#6580)

Browse Source
This commit is contained in:
Dan Davison 2022-09-18 11:24:27 -04:00 committed by GitHub
parent 15ebf45f46
commit d704b05b7a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
crates/nu-command/src/filters/uniq.rs
View File

@ -14,23 +14,31 @@ impl Command for Uniq {
fn signature(&self) -> Signature { fn signature(&self) -> Signature {
Signature::build("uniq") Signature::build("uniq")
.switch("count", "Count the unique rows", Some('c')) .switch(
"count",
"Return a table containing the distinct input values together with their counts",
Some('c'),
)
.switch( .switch(
"repeated", "repeated",
"Count the rows that has more than one value", "Return the input values that occur more than once",
Some('d'), Some('d'),
) )
.switch( .switch(
"ignore-case", "ignore-case",
"Ignore differences in case when comparing", "Ignore differences in case when comparing input values",
Some('i'), Some('i'),
) )
.switch("unique", "Only return unique values", Some('u')) .switch(
"unique",
"Return the input values that occur once only",
Some('u'),
)
.category(Category::Filters) .category(Category::Filters)
} }
fn usage(&self) -> &str { fn usage(&self) -> &str {
"Return the unique rows." "Return the distinct values in the input."
} }
fn search_terms(&self) -> Vec<&str> { fn search_terms(&self) -> Vec<&str> {
@ -50,7 +58,7 @@ impl Command for Uniq {
fn examples(&self) -> Vec<Example> { fn examples(&self) -> Vec<Example> {
vec![ vec![
Example { Example {
description: "Remove duplicate rows of a list/table", description: "Return the distinct values of a list/table (remove duplicates so that each value occurs once only)",
example: "[2 3 3 4] | uniq", example: "[2 3 3 4] | uniq",
result: Some(Value::List { result: Some(Value::List {
vals: vec![Value::test_int(2), Value::test_int(3), Value::test_int(4)], vals: vec![Value::test_int(2), Value::test_int(3), Value::test_int(4)],
@ -58,7 +66,7 @@ impl Command for Uniq {
}), }),
}, },
Example { Example {
description: "Only print duplicate lines, one for each group", description: "Return the input values that occur more than once",
example: "[1 2 2] | uniq -d", example: "[1 2 2] | uniq -d",
result: Some(Value::List { result: Some(Value::List {
vals: vec![Value::test_int(2)], vals: vec![Value::test_int(2)],
@ -66,7 +74,7 @@ impl Command for Uniq {
}), }),
}, },
Example { Example {
description: "Only print unique lines lines", description: "Return the input values that occur once only",
example: "[1 2 2] | uniq -u", example: "[1 2 2] | uniq -u",
result: Some(Value::List { result: Some(Value::List {
vals: vec![Value::test_int(1)], vals: vec![Value::test_int(1)],
@ -74,7 +82,7 @@ impl Command for Uniq {
}), }),
}, },
Example { Example {
description: "Ignore differences in case when comparing", description: "Ignore differences in case when comparing input values",
example: "['hello' 'goodbye' 'Hello'] | uniq -i", example: "['hello' 'goodbye' 'Hello'] | uniq -i",
result: Some(Value::List { result: Some(Value::List {
vals: vec![Value::test_string("hello"), Value::test_string("goodbye")], vals: vec![Value::test_string("hello"), Value::test_string("goodbye")],
@ -82,7 +90,7 @@ impl Command for Uniq {
}), }),
}, },
Example { Example {
description: "Remove duplicate rows and show counts of a list/table", description: "Return a table containing the distinct input values together with their counts",
example: "[1 2 2] | uniq -c", example: "[1 2 2] | uniq -c",
result: Some(Value::List { result: Some(Value::List {
vals: vec![ vals: vec![