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

Revert "Port command examples to long option" (#10597)

Browse Source 
Reverts nushell/nushell#10596

Using the long option in examples is going to be confusing as it makes
the reader think the long option is required. It also isn't idiomatic
Nushell.

The examples should be copy-paste-able as idiomatic Nushell, so as such
we shouldn't expand them to the long flag name.
This commit is contained in:
JT 2023-10-04 09:41:13 +13:00 committed by GitHub
parent 4a82ee6c11
commit 8c507dc984
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
crates/nu-command/src/filesystem/cp.rs
View File

@ -359,12 +359,12 @@ impl Command for Cp {
}, },
Example { Example {
description: "Recursively copy dir_a to dir_b", description: "Recursively copy dir_a to dir_b",
example: "cp --recursive dir_a dir_b", example: "cp -r dir_a dir_b",
result: None, result: None,
}, },
Example { Example {
description: "Recursively copy dir_a to dir_b, and print the feedbacks", description: "Recursively copy dir_a to dir_b, and print the feedbacks",
example: "cp --recursive --verbose dir_a dir_b", example: "cp -r -v dir_a dir_b",
result: None, result: None,
}, },
Example { Example {
@ -374,7 +374,7 @@ impl Command for Cp {
}, },
Example { Example {
description: "Copy only if source file is newer than target file", description: "Copy only if source file is newer than target file",
example: "cp --update a b", example: "cp -u a b",
result: None, result: None,
}, },
] ]

4
crates/nu-command/src/filesystem/ucp.rs
View File

@ -68,12 +68,12 @@ impl Command for UCp {
}, },
Example { Example {
description: "Recursively copy dir_a to dir_b", description: "Recursively copy dir_a to dir_b",
example: "ucp --recursive dir_a dir_b", example: "ucp -r dir_a dir_b",
result: None, result: None,
}, },
Example { Example {
description: "Recursively copy dir_a to dir_b, and print the feedbacks", description: "Recursively copy dir_a to dir_b, and print the feedbacks",
example: "ucp --recursive --verbose dir_a dir_b", example: "ucp -r -v dir_a dir_b",
result: None, result: None,
}, },
Example { Example {

2
crates/nu-command/src/viewers/table.rs
View File

@ -134,7 +134,7 @@ impl Command for Table {
vec![ vec![
Example { Example {
description: "List the files in current directory, with indexes starting from 1.", description: "List the files in current directory, with indexes starting from 1.",
example: r#"ls | table --start-number 1"#, example: r#"ls | table -n 1"#,
result: None, result: None,
}, },
Example { Example {

4
crates/nu-explore/src/explore.rs
View File

@ -113,13 +113,13 @@ impl Command for Explore {
}, },
Example { Example {
description: "Explore a list of Markdown files' contents, with row indexes", description: "Explore a list of Markdown files' contents, with row indexes",
example: r#"glob *.md | each {|| open } | explore --index"#, example: r#"glob *.md | each {|| open } | explore -i"#,
result: None, result: None,
}, },
Example { Example {
description: description:
"Explore a JSON file, then save the last visited sub-structure to a file", "Explore a JSON file, then save the last visited sub-structure to a file",
example: r#"open file.json | explore --peek | to json | save part.json"#, example: r#"open file.json | explore -p | to json | save part.json"#,
result: None, result: None,
}, },
] ]