Regenerate command docs (#1665)

hustcer · web-flow · commit 0d85a9803c84 · 2024-12-06T09:57:08.000+08:00
* Regenerate command docs

* chore: Fix polars_profile.md
diff --git a/commands/docs/cal.md b/commands/docs/cal.md
@@ -24,9 +24,9 @@ usage: |
  -  `--quarter, -q`: Display the quarter column
  -  `--month, -m`: Display the month column
  -  `--as-table, -t`: output as a table
- -  `--full-year, - {int}`: Display a year-long calendar for the specified year
- -  `--week-start, - {string}`: Display the calendar with the specified day as the first day of the week
- -  `--month-names, -`: Display the month names instead of integers
+ -  `--full-year {int}`: Display a year-long calendar for the specified year
+ -  `--week-start {string}`: Display the calendar with the specified day as the first day of the week
+ -  `--month-names`: Display the month names instead of integers
 
 
 ## Input/output types:
diff --git a/commands/docs/collect.md b/commands/docs/collect.md
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--keep-env, -`: let the closure affect environment variables
+ -  `--keep-env`: let the closure affect environment variables
 
 ## Parameters
 
diff --git a/commands/docs/cp.md b/commands/docs/cp.md
@@ -29,10 +29,10 @@ usage: |
  -  `--update, -u`: copy only when the SOURCE file is newer than the destination file or when the destination file is missing
  -  `--progress, -p`: display a progress bar
  -  `--no-clobber, -n`: do not overwrite an existing file
- -  `--preserve, - {list<string>}`: preserve only the specified attributes (empty list means no attributes preserved)
+ -  `--preserve {list<string>}`: preserve only the specified attributes (empty list means no attributes preserved)
                     if not specified only mode is preserved
                     possible values: mode, ownership (unix only), timestamps, context, link, links, xattr
- -  `--debug, -`: explain how a file is copied. Implies -v
+ -  `--debug`: explain how a file is copied. Implies -v
 
 ## Parameters
 
diff --git a/commands/docs/decode_base32.md b/commands/docs/decode_base32.md
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--nopad, -`: Do not pad the output.
+ -  `--nopad`: Do not pad the output.
 
 
 ## Input/output types:
diff --git a/commands/docs/decode_base32hex.md b/commands/docs/decode_base32hex.md
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--nopad, -`: Reject input with padding.
+ -  `--nopad`: Reject input with padding.
 
 
 ## Input/output types:
diff --git a/commands/docs/decode_base64.md b/commands/docs/decode_base64.md
@@ -20,8 +20,8 @@ usage: |
 
 ## Flags
 
- -  `--url, -`: Decode the URL-safe Base64 version.
- -  `--nopad, -`: Reject padding.
+ -  `--url`: Decode the URL-safe Base64 version.
+ -  `--nopad`: Reject padding.
 
 
 ## Input/output types:
diff --git a/commands/docs/def.md b/commands/docs/def.md
@@ -20,8 +20,8 @@ usage: |
 
 ## Flags
 
- -  `--env, -`: keep the environment defined inside the command
- -  `--wrapped, -`: treat unknown flags and arguments as strings (requires ...rest-like parameter in signature)
+ -  `--env`: keep the environment defined inside the command
+ -  `--wrapped`: treat unknown flags and arguments as strings (requires ...rest-like parameter in signature)
 
 ## Parameters
 
diff --git a/commands/docs/detect_columns.md b/commands/docs/detect_columns.md
@@ -23,7 +23,7 @@ usage: |
  -  `--skip, -s {int}`: number of rows to skip before detecting
  -  `--no-headers, -n`: don't detect headers
  -  `--combine-columns, -c {range}`: columns to be combined; listed as a range
- -  `--guess, -`: detect columns by guessing width, it may be useful if default one doesn't work
+ -  `--guess`: detect columns by guessing width, it may be useful if default one doesn't work
 
 
 ## Input/output types:
diff --git a/commands/docs/do.md b/commands/docs/do.md
@@ -24,7 +24,7 @@ usage: |
  -  `--ignore-shell-errors, -s`: ignore shell errors as the closure runs
  -  `--ignore-program-errors, -p`: ignore external program errors as the closure runs
  -  `--capture-errors, -c`: catch errors as the closure runs, and return them
- -  `--env, -`: keep the environment defined inside the command
+ -  `--env`: keep the environment defined inside the command
 
 ## Parameters
 
diff --git a/commands/docs/encode_base32.md b/commands/docs/encode_base32.md
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--nopad, -`: Don't accept padding.
+ -  `--nopad`: Don't accept padding.
 
 
 ## Input/output types:
diff --git a/commands/docs/encode_base32hex.md b/commands/docs/encode_base32hex.md
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--nopad, -`: Don't pad the output.
+ -  `--nopad`: Don't pad the output.
 
 
 ## Input/output types:
diff --git a/commands/docs/encode_base64.md b/commands/docs/encode_base64.md
@@ -20,8 +20,8 @@ usage: |
 
 ## Flags
 
- -  `--url, -`: Use the URL-safe Base64 version.
- -  `--nopad, -`: Don't pad the output.
+ -  `--url`: Use the URL-safe Base64 version.
+ -  `--nopad`: Don't pad the output.
 
 
 ## Input/output types:
diff --git a/commands/docs/encode_hex.md b/commands/docs/encode_hex.md
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--lower, -`: Encode to lowercase hex.
+ -  `--lower`: Encode to lowercase hex.
 
 
 ## Input/output types:
diff --git a/commands/docs/explore.md b/commands/docs/explore.md
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--head, - {bool}`: Show or hide column headers (default true)
+ -  `--head {bool}`: Show or hide column headers (default true)
  -  `--index, -i`: Show row indexes when viewing a list
  -  `--tail, -t`: Start with the viewport scrolled to the bottom
  -  `--peek, -p`: When quitting, output the value of the cell the cursor was on
diff --git a/commands/docs/export_def.md b/commands/docs/export_def.md
@@ -20,8 +20,8 @@ usage: |
 
 ## Flags
 
- -  `--env, -`: keep the environment defined inside the command
- -  `--wrapped, -`: treat unknown flags and arguments as strings (requires ...rest-like parameter in signature)
+ -  `--env`: keep the environment defined inside the command
+ -  `--wrapped`: treat unknown flags and arguments as strings (requires ...rest-like parameter in signature)
 
 ## Parameters
 
diff --git a/commands/docs/from_csv.md b/commands/docs/from_csv.md
@@ -25,8 +25,8 @@ usage: |
  -  `--quote, -q {string}`: a quote character to ignore separators in strings, defaults to '"'
  -  `--escape, -e {string}`: an escape character for strings containing the quote character
  -  `--noheaders, -n`: don't treat the first row as column names
- -  `--flexible, -`: allow the number of fields in records to be variable
- -  `--no-infer, -`: no field type inferencing
+ -  `--flexible`: allow the number of fields in records to be variable
+ -  `--no-infer`: no field type inferencing
  -  `--trim, -t {string}`: drop leading and trailing whitespaces around headers names and/or field values
 
 
diff --git a/commands/docs/from_msgpack.md b/commands/docs/from_msgpack.md
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--objects, -`: Read multiple objects from input
+ -  `--objects`: Read multiple objects from input
 
 
 ## Input/output types:
diff --git a/commands/docs/from_msgpackz.md b/commands/docs/from_msgpackz.md
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--objects, -`: Read multiple objects from input
+ -  `--objects`: Read multiple objects from input
 
 
 ## Input/output types:
diff --git a/commands/docs/from_tsv.md b/commands/docs/from_tsv.md
@@ -24,8 +24,8 @@ usage: |
  -  `--quote, -q {string}`: a quote character to ignore separators in strings, defaults to '"'
  -  `--escape, -e {string}`: an escape character for strings containing the quote character
  -  `--noheaders, -n`: don't treat the first row as column names
- -  `--flexible, -`: allow the number of fields in records to be variable
- -  `--no-infer, -`: no field type inferencing
+ -  `--flexible`: allow the number of fields in records to be variable
+ -  `--no-infer`: no field type inferencing
  -  `--trim, -t {string}`: drop leading and trailing whitespaces around headers names and/or field values
 
 
diff --git a/commands/docs/from_xml.md b/commands/docs/from_xml.md
@@ -20,8 +20,8 @@ usage: |
 
 ## Flags
 
- -  `--keep-comments, -`: add comment nodes to result
- -  `--keep-pi, -`: add processing instruction nodes to result
+ -  `--keep-comments`: add comment nodes to result
+ -  `--keep-pi`: add processing instruction nodes to result
 
 
 ## Input/output types:
diff --git a/commands/docs/group-by.md b/commands/docs/group-by.md
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--to-table, -`: Return a table with "groups" and "items" columns
+ -  `--to-table`: Return a table with "groups" and "items" columns
 
 ## Parameters
 
diff --git a/commands/docs/into_datetime.md b/commands/docs/into_datetime.md
@@ -63,7 +63,7 @@ Sat, 27 Feb 2021 13:55:40 +0000 (3 years ago)
 Convert non-standard timestamp string, without timezone offset, to datetime with custom formatting
 ```nu
 > '16.11.1984 8:00 am' | into datetime --format '%d.%m.%Y %H:%M %P'
-Fri, 16 Nov 1984 08:00:00 +0800 (40 years ago)
+Fri, 16 Nov 1984 08:00:00 +0000 (40 years ago)
 ```
 
 Convert nanosecond-precision unix timestamp to a datetime with offset from UTC
@@ -84,7 +84,7 @@ Convert list of timestamps to datetimes
 ╭───┬─────────────╮
 │ 0 │ 2 years ago │
 │ 1 │ 2 years ago │
-│ 2 │ a year ago  │
+│ 2 │ 2 years ago │
 ╰───┴─────────────╯
 
 ```
diff --git a/commands/docs/mktemp.md b/commands/docs/mktemp.md
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--suffix, - {string}`: Append suffix to template; must not contain a slash.
+ -  `--suffix {string}`: Append suffix to template; must not contain a slash.
  -  `--tmpdir-path, -p {path}`: Interpret TEMPLATE relative to tmpdir-path. If tmpdir-path is not set use $TMPDIR
  -  `--tmpdir, -t`: Interpret TEMPLATE relative to the system temporary directory.
  -  `--directory, -d`: Create a directory instead of a file.
diff --git a/commands/docs/move.md b/commands/docs/move.md
@@ -20,8 +20,8 @@ usage: |
 
 ## Flags
 
- -  `--after, - {string}`: the column that will precede the columns moved
- -  `--before, - {string}`: the column that will be the next after the columns moved
+ -  `--after {string}`: the column that will precede the columns moved
+ -  `--before {string}`: the column that will be the next after the columns moved
 
 ## Parameters
 
diff --git a/commands/docs/plugin_add.md b/commands/docs/plugin_add.md
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--plugin-config, - {path}`: Use a plugin registry file other than the one set in `$nu.plugin-path`
+ -  `--plugin-config {path}`: Use a plugin registry file other than the one set in `$nu.plugin-path`
  -  `--shell, -s {path}`: Use an additional shell program (cmd, sh, python, etc.) to run the plugin
 
 ## Parameters
diff --git a/commands/docs/plugin_list.md b/commands/docs/plugin_list.md
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--plugin-config, - {path}`: Use a plugin registry file other than the one set in `$nu.plugin-path`
+ -  `--plugin-config {path}`: Use a plugin registry file other than the one set in `$nu.plugin-path`
  -  `--engine, -e`: Show info for plugins that are loaded into the engine only.
  -  `--registry, -r`: Show info for plugins from the registry file only.
 
diff --git a/commands/docs/plugin_rm.md b/commands/docs/plugin_rm.md
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--plugin-config, - {path}`: Use a plugin registry file other than the one set in `$nu.plugin-path`
+ -  `--plugin-config {path}`: Use a plugin registry file other than the one set in `$nu.plugin-path`
  -  `--force, -f`: Don't cause an error if the plugin name wasn't found in the file
 
 ## Parameters
diff --git a/commands/docs/plugin_use.md b/commands/docs/plugin_use.md
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--plugin-config, - {path}`: Use a plugin registry file other than the one set in `$nu.plugin-path`
+ -  `--plugin-config {path}`: Use a plugin registry file other than the one set in `$nu.plugin-path`
 
 ## Parameters
 
diff --git a/commands/docs/polars_concat.md b/commands/docs/polars_concat.md
@@ -27,11 +27,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information.
 
 ## Flags
 
- -  `--no-parallel, -`: Disable parallel execution
- -  `--rechunk, -`: Rechunk the resulting dataframe
- -  `--to-supertypes, -`: Cast to supertypes
- -  `--diagonal, -`: Concatenate dataframes diagonally
- -  `--from-partitioned-ds, -`: Concatenate dataframes from a partitioned dataset
+ -  `--no-parallel`: Disable parallel execution
+ -  `--rechunk`: Rechunk the resulting dataframe
+ -  `--to-supertypes`: Cast to supertypes
+ -  `--diagonal`: Concatenate dataframes diagonally
+ -  `--from-partitioned-ds`: Concatenate dataframes from a partitioned dataset
 
 ## Parameters
 
diff --git a/commands/docs/polars_open.md b/commands/docs/polars_open.md
@@ -27,15 +27,15 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information.
 
 ## Flags
 
- -  `--eager, -`: Open dataframe as an eager dataframe
+ -  `--eager`: Open dataframe as an eager dataframe
  -  `--type, -t {string}`: File type: csv, tsv, json, parquet, arrow, avro. If omitted, derive from file extension
  -  `--delimiter, -d {string}`: file delimiter character. CSV file
- -  `--no-header, -`: Indicates if file doesn't have header. CSV file
- -  `--infer-schema, - {number}`: Number of rows to infer the schema of the file. CSV file
- -  `--skip-rows, - {number}`: Number of rows to skip from file. CSV file
- -  `--columns, - {list<string>}`: Columns to be selected from csv file. CSV and Parquet file
+ -  `--no-header`: Indicates if file doesn't have header. CSV file
+ -  `--infer-schema {number}`: Number of rows to infer the schema of the file. CSV file
+ -  `--skip-rows {number}`: Number of rows to skip from file. CSV file
+ -  `--columns {list<string>}`: Columns to be selected from csv file. CSV and Parquet file
  -  `--schema, -s {record}`: Polars Schema in format [{name: str}]. CSV, JSON, and JSONL files
- -  `--truncate-ragged-lines, -`: Truncate lines that are longer than the schema. CSV file
+ -  `--truncate-ragged-lines`: Truncate lines that are longer than the schema. CSV file
 
 ## Parameters
 
diff --git a/commands/docs/polars_save.md b/commands/docs/polars_save.md
@@ -28,9 +28,9 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information.
 ## Flags
 
  -  `--type, -t {string}`: File type: csv, json, parquet, arrow/ipc. If omitted, derive from file extension
- -  `--avro-compression, - {string}`: Compression for avro supports deflate or snappy
- -  `--csv-delimiter, - {string}`: file delimiter character
- -  `--csv-no-header, -`: Indicates to exclude a header row for CSV files.
+ -  `--avro-compression {string}`: Compression for avro supports deflate or snappy
+ -  `--csv-delimiter {string}`: file delimiter character
+ -  `--csv-no-header`: Indicates to exclude a header row for CSV files.
 
 ## Parameters
 
diff --git a/commands/docs/rotate.md b/commands/docs/rotate.md
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--ccw, -`: rotate counter clockwise
+ -  `--ccw`: rotate counter clockwise
 
 ## Parameters
 
diff --git a/commands/docs/str_expand.md b/commands/docs/str_expand.md
@@ -20,7 +20,7 @@ usage: |
 
 ## Flags
 
- -  `--path, -`: Replaces all backslashes with double backslashes, useful for Path.
+ -  `--path`: Replaces all backslashes with double backslashes, useful for Path.
 
 
 ## Input/output types:
diff --git a/commands/docs/table.md b/commands/docs/table.md
@@ -25,8 +25,8 @@ usage: |
  -  `--width, -w {int}`: number of terminal columns wide (not output columns)
  -  `--expand, -e`: expand the table structure in a light mode
  -  `--expand-deep, -d {int}`: an expand limit of recursion which will take place, must be used with --expand
- -  `--flatten, -`: Flatten simple arrays
- -  `--flatten-separator, - {string}`: sets a separator when 'flatten' used
+ -  `--flatten`: Flatten simple arrays
+ -  `--flatten-separator {string}`: sets a separator when 'flatten' used
  -  `--collapse, -c`: expand the table structure in collapse mode.
 Be aware collapse mode currently doesn't support width control
  -  `--abbreviated, -a {int}`: abbreviate the data in the table by truncating the middle part and only showing amount provided on top and bottom
diff --git a/commands/docs/to_csv.md b/commands/docs/to_csv.md
@@ -22,7 +22,7 @@ usage: |
 
  -  `--separator, -s {string}`: a character to separate columns, defaults to ','
  -  `--noheaders, -n`: do not output the columns names as the first row
- -  `--columns, - {list<string>}`: the names (in order) of the columns to use
+ -  `--columns {list<string>}`: the names (in order) of the columns to use
 
 
 ## Input/output types:
diff --git a/commands/docs/to_tsv.md b/commands/docs/to_tsv.md
@@ -21,7 +21,7 @@ usage: |
 ## Flags
 
  -  `--noheaders, -n`: do not output the column names as the first row
- -  `--columns, - {list<string>}`: the names (in order) of the columns to use
+ -  `--columns {list<string>}`: the names (in order) of the columns to use
 
 
 ## Input/output types:
diff --git a/commands/docs/ulimit.md b/commands/docs/ulimit.md
