From 461837773b1886ce51d8abedb63e62f2879bf8a0 Mon Sep 17 00:00:00 2001
From: Darren Schroeder <343840+fdncred@users.noreply.github.com>
Date: Thu, 16 Nov 2023 08:20:52 -0600
Subject: [PATCH] correct table example syntax (#11074)

# Description

Correct an example that had old syntax.

# 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.
-->
---
 crates/nu-command/src/viewers/table.rs | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/crates/nu-command/src/viewers/table.rs b/crates/nu-command/src/viewers/table.rs
index ca884ab834..14eb0ece6d 100644
--- a/crates/nu-command/src/viewers/table.rs
+++ b/crates/nu-command/src/viewers/table.rs
@@ -73,7 +73,7 @@ impl Command for Table {
             .named(
                 "index",
                 SyntaxShape::Any,
-                "enable or disable the #/index column or set the starting index",
+                "enable (true) or disable (false) the #/index column or set the starting index",
                 Some('i'),
             )
             .named(
@@ -90,7 +90,7 @@ impl Command for Table {
             .named(
                 "expand-deep",
                 SyntaxShape::Int,
-                "an expand limit of recursion which will take place. must be used with expand",
+                "an expand limit of recursion which will take place, must be used with --expand",
                 Some('d'),
             )
             .switch("flatten", "Flatten simple arrays", None)
@@ -145,7 +145,7 @@ impl Command for Table {
         vec![
             Example {
                 description: "List the files in current directory, with indexes starting from 1",
-                example: r#"ls | table --start-number 1"#,
+                example: r#"ls | table --index 1"#,
                 result: None,
             },
             Example {
@@ -201,7 +201,8 @@ impl Command for Table {
                 result: None,
             },
             Example {
-                description: "Set the starting number of the #/index column for a single run",
+                description:
+                    "Set the starting number of the #/index column to 100 for a single run",
                 example: r#"[[a b]; [1 2] [2 [4 4]]] | table -i 100"#,
                 result: None,
             },