tweak table example/parameter text (#11071)

# Description

This PR just tweaks the `table` example text and some parameter text.

# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->

# Tests + Formatting
<!--
Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to
check that you're using the standard code style
- `cargo test --workspace` to check that all tests pass (on Windows make
sure to [enable developer
mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging))
- `cargo run -- -c "use std testing; testing run-tests --path
crates/nu-std"` to run the tests for the standard library

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```
-->

# After Submitting
<!-- If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
-->
This commit is contained in:
Darren Schroeder 2023-11-16 05:35:55 -06:00 committed by GitHub
parent a1dfc35968
commit 274a8366c6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -73,7 +73,7 @@ impl Command for Table {
.named( .named(
"index", "index",
SyntaxShape::Any, SyntaxShape::Any,
"set or set off a index mode/theme", "enable or disable the #/index column or set the starting index",
Some('i'), Some('i'),
) )
.named( .named(
@ -90,7 +90,7 @@ impl Command for Table {
.named( .named(
"expand-deep", "expand-deep",
SyntaxShape::Int, SyntaxShape::Int,
"an expand limit of recursion which will take place", "an expand limit of recursion which will take place. must be used with expand",
Some('d'), Some('d'),
) )
.switch("flatten", "Flatten simple arrays", None) .switch("flatten", "Flatten simple arrays", None)
@ -144,7 +144,7 @@ impl Command for Table {
fn examples(&self) -> Vec<Example> { fn examples(&self) -> Vec<Example> {
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 --start-number 1"#,
result: None, result: None,
}, },
@ -191,22 +191,22 @@ impl Command for Table {
])), ])),
}, },
Example { Example {
description: "Change a theme", description: "Change the table theme to the specified theme for a single run",
example: r#"[[a b]; [1 2] [2 [4 4]]] | table --theme basic"#, example: r#"[[a b]; [1 2] [2 [4 4]]] | table --theme basic"#,
result: None, result: None,
}, },
Example { Example {
description: "Force a show of an index", description: "Force showing of the #/index column for a single run",
example: r#"[[a b]; [1 2] [2 [4 4]]] | table -i"#, example: r#"[[a b]; [1 2] [2 [4 4]]] | table -i true"#,
result: None, result: None,
}, },
Example { Example {
description: "Set an index to start from a value", description: "Set the starting number of the #/index column for a single run",
example: r#"[[a b]; [1 2] [2 [4 4]]] | table -i 100"#, example: r#"[[a b]; [1 2] [2 [4 4]]] | table -i 100"#,
result: None, result: None,
}, },
Example { Example {
description: "Remove an index", description: "Force hiding of the #/index column for a single run",
example: r#"[[a b]; [1 2] [2 [4 4]]] | table -i false"#, example: r#"[[a b]; [1 2] [2 [4 4]]] | table -i false"#,
result: None, result: None,
}, },