From d8ef22c18d90b6bf1cce81c104cedd9fc5fc96cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Paulie=20Pe=C3=B1a?= <203125+paulie4@users.noreply.github.com> Date: Tue, 3 Dec 2024 10:21:17 -0500 Subject: [PATCH 1/3] `make_docs.nu`: fix flags code to only add `short_flag` when needed --- make_docs.nu | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/make_docs.nu b/make_docs.nu index 5c5a353afe2..6885de7923d 100644 --- a/make_docs.nu +++ b/make_docs.nu @@ -169,11 +169,14 @@ def command-doc [command] { let flags = if $no_flags { '' } else { ($command.signatures | get $columns.0 | each { |param| - if $param.parameter_type == "switch" { - $" - `--($param.parameter_name), -($param.short_flag)`: ($param.description)" - } else if $param.parameter_type == "named" { - $" - `--($param.parameter_name), -($param.short_flag) {($param.syntax_shape)}`: ($param.description)" - } + let start = $' - `--($param.parameter_name)' + let end = $'`: ($param.description)' + let short_flag = (if ($param.short_flag | is-empty) {''} else {$', -($param.short_flag)'}) + if $param.parameter_type == 'switch' { + $'($start)($short_flag)($end)' + } else if $param.parameter_type == 'named' { + $'($start)($short_flag) {($param.syntax_shape)}($end)' + } } | str join (char newline)) } From ffbe438c9d113a7b15f4fa9ad92b2223eac9433a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Paulie=20Pe=C3=B1a?= <203125+paulie4@users.noreply.github.com> Date: Tue, 3 Dec 2024 10:21:53 -0500 Subject: [PATCH 2/3] run `make_docs.nu` --- .vuepress/configs/sidebar/command_categories.ts | 7 +------ commands/docs/cal.md | 6 +++--- commands/docs/collect.md | 2 +- commands/docs/cp.md | 4 ++-- commands/docs/decode_base32.md | 2 +- commands/docs/decode_base32hex.md | 2 +- commands/docs/decode_base64.md | 4 ++-- commands/docs/def.md | 4 ++-- commands/docs/detect_columns.md | 2 +- commands/docs/do.md | 2 +- commands/docs/encode_base32.md | 2 +- commands/docs/encode_base32hex.md | 2 +- commands/docs/encode_base64.md | 4 ++-- commands/docs/encode_hex.md | 2 +- commands/docs/explore.md | 2 +- commands/docs/export_def.md | 4 ++-- commands/docs/from.md | 5 ----- commands/docs/from_csv.md | 4 ++-- commands/docs/from_msgpack.md | 2 +- commands/docs/from_msgpackz.md | 2 +- commands/docs/from_tsv.md | 4 ++-- commands/docs/from_xml.md | 4 ++-- commands/docs/group-by.md | 2 +- commands/docs/into_datetime.md | 4 ++-- commands/docs/mktemp.md | 2 +- commands/docs/move.md | 4 ++-- commands/docs/plugin_add.md | 2 +- commands/docs/plugin_list.md | 2 +- commands/docs/plugin_rm.md | 2 +- commands/docs/plugin_use.md | 2 +- commands/docs/rotate.md | 2 +- commands/docs/str_expand.md | 2 +- commands/docs/table.md | 4 ++-- commands/docs/to.md | 1 - commands/docs/to_csv.md | 2 +- commands/docs/to_tsv.md | 2 +- commands/docs/ulimit.md | 9 +++++++++ 37 files changed, 56 insertions(+), 58 deletions(-) diff --git a/.vuepress/configs/sidebar/command_categories.ts b/.vuepress/configs/sidebar/command_categories.ts index b396886c265..e315b4a1607 100644 --- a/.vuepress/configs/sidebar/command_categories.ts +++ b/.vuepress/configs/sidebar/command_categories.ts @@ -5,31 +5,26 @@ export const commandCategories = [ '/commands/categories/conversions.md', '/commands/categories/core.md', '/commands/categories/database.md', - '/commands/categories/dataframe.md', - '/commands/categories/dataframe_or_lazyframe.md', '/commands/categories/date.md', '/commands/categories/debug.md', '/commands/categories/default.md', '/commands/categories/env.md', - '/commands/categories/expression.md', '/commands/categories/filesystem.md', '/commands/categories/filters.md', '/commands/categories/formats.md', '/commands/categories/generators.md', '/commands/categories/hash.md', '/commands/categories/history.md', - '/commands/categories/lazyframe.md', '/commands/categories/math.md', '/commands/categories/misc.md', '/commands/categories/network.md', '/commands/categories/path.md', '/commands/categories/platform.md', '/commands/categories/plugin.md', - '/commands/categories/prompt.md', '/commands/categories/random.md', '/commands/categories/removed.md', '/commands/categories/shells.md', '/commands/categories/strings.md', '/commands/categories/system.md', '/commands/categories/viewers.md', -]; +]; \ No newline at end of file diff --git a/commands/docs/cal.md b/commands/docs/cal.md index 54c7140d629..13621891594 100644 --- 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 index dba14976631..0a819b37bc3 100644 --- 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 index 9262156512b..c09563fb015 100644 --- 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}`: preserve only the specified attributes (empty list means no attributes preserved) + - `--preserve {list}`: 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 index ea3ab91483c..b7b78e90283 100644 --- 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 index 528790cd6de..5acb5a1793b 100644 --- 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 index d1f20df143c..527ef3e20ac 100644 --- 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 index 3ab44494109..c7a31648101 100644 --- 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 index 8d30fc3a120..9aed04aa6b9 100644 --- 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 index d6facd4e293..cf4303b46fa 100644 --- 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 index eadf695ae99..d848b53b711 100644 --- 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 index f5b975b5de1..1cc0ea90a0b 100644 --- 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 index 5080a213a41..81950becce4 100644 --- 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 index c68c1c4b868..5c06c5586cc 100644 --- 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 index d1b4a422e5b..04ae758c730 100644 --- 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 index ccf8c5fdaeb..f51ecb981ec 100644 --- 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.md b/commands/docs/from.md index 060341caac8..e7fd7bab7ba 100644 --- a/commands/docs/from.md +++ b/commands/docs/from.md @@ -33,20 +33,15 @@ You must use one of the following subcommands. Using this command as-is will onl | name | description | type | | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------- | | [`from csv`](/commands/docs/from_csv.md) | Parse text as .csv and create table. | built-in | -| [`from eml`](/commands/docs/from_eml.md) | Parse text as .eml and create record. | plugin | -| [`from ics`](/commands/docs/from_ics.md) | Parse text as .ics and create table. | plugin | -| [`from ini`](/commands/docs/from_ini.md) | Parse text as .ini and create table. | plugin | | [`from json`](/commands/docs/from_json.md) | Convert from json to structured data. | built-in | | [`from msgpack`](/commands/docs/from_msgpack.md) | Convert MessagePack data into Nu values. | built-in | | [`from msgpackz`](/commands/docs/from_msgpackz.md) | Convert brotli-compressed MessagePack data into Nu values. | built-in | | [`from nuon`](/commands/docs/from_nuon.md) | Convert from nuon to structured data. | built-in | | [`from ods`](/commands/docs/from_ods.md) | Parse OpenDocument Spreadsheet(.ods) data and create table. | built-in | -| [`from plist`](/commands/docs/from_plist.md) | Convert plist to Nushell values | plugin | | [`from ssv`](/commands/docs/from_ssv.md) | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. | built-in | | [`from toml`](/commands/docs/from_toml.md) | Parse text as .toml and create record. | built-in | | [`from tsv`](/commands/docs/from_tsv.md) | Parse text as .tsv and create table. | built-in | | [`from url`](/commands/docs/from_url.md) | Parse url-encoded string as a record. | built-in | -| [`from vcf`](/commands/docs/from_vcf.md) | Parse text as .vcf and create table. | plugin | | [`from xlsx`](/commands/docs/from_xlsx.md) | Parse binary Excel(.xlsx) data and create table. | built-in | | [`from xml`](/commands/docs/from_xml.md) | Parse text as .xml and create record. | built-in | | [`from yaml`](/commands/docs/from_yaml.md) | Parse text as .yaml/.yml and create table. | built-in | diff --git a/commands/docs/from_csv.md b/commands/docs/from_csv.md index 06dc1f08c79..2581535eb34 100644 --- 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 index 37d7376c707..5f58a5a0c0a 100644 --- 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 index bd4d01091fb..43a53a476d4 100644 --- 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 index 0ca89a7e502..67e4cd5fa00 100644 --- 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 index 248bd7d8058..971cdfca8d0 100644 --- 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 index b9cfd0f13db..bf8892fa102 100644 --- 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 index 945758ca272..40571fb3e3e 100644 --- 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 -0500 (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 index 13c292cbba9..867ea2857b9 100644 --- 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 index f5ae5c05005..849449c7035 100644 --- 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 index e40ce500906..a1138f0e984 100644 --- 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 index d32b1c68b2a..7acd9eba370 100644 --- 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 index 56479928e91..ee103685aff 100644 --- 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 index b56f14c411f..57916daba96 100644 --- 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/rotate.md b/commands/docs/rotate.md index bfefac406e6..b394843f6fa 100644 --- 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 index 3fa1994de36..7ca9115540d 100644 --- 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 index d9352b410ce..83ef33d26aa 100644 --- 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.md b/commands/docs/to.md index 007805955b9..27be4ccb5ce 100644 --- a/commands/docs/to.md +++ b/commands/docs/to.md @@ -39,7 +39,6 @@ You must use one of the following subcommands. Using this command as-is will onl | [`to msgpack`](/commands/docs/to_msgpack.md) | Convert Nu values into MessagePack. | built-in | | [`to msgpackz`](/commands/docs/to_msgpackz.md) | Convert Nu values into brotli-compressed MessagePack. | built-in | | [`to nuon`](/commands/docs/to_nuon.md) | Converts table data into Nuon (Nushell Object Notation) text. | built-in | -| [`to plist`](/commands/docs/to_plist.md) | Convert Nu values into plist | plugin | | [`to text`](/commands/docs/to_text.md) | Converts data into simple text. | built-in | | [`to toml`](/commands/docs/to_toml.md) | Convert record into .toml text. | built-in | | [`to tsv`](/commands/docs/to_tsv.md) | Convert table into .tsv text. | built-in | diff --git a/commands/docs/to_csv.md b/commands/docs/to_csv.md index 5d2b31a7db2..2948bf77bf1 100644 --- 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}`: the names (in order) of the columns to use + - `--columns {list}`: 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 index f10e408cc95..b374c58043c 100644 --- 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}`: the names (in order) of the columns to use + - `--columns {list}`: the names (in order) of the columns to use ## Input/output types: diff --git a/commands/docs/ulimit.md b/commands/docs/ulimit.md index 876fafab16d..44960660480 100644 --- a/commands/docs/ulimit.md +++ b/commands/docs/ulimit.md @@ -25,11 +25,20 @@ usage: | - `--all, -a`: Prints all current limits - `--core-size, -c`: Maximum size of core files created - `--data-size, -d`: Maximum size of a process's data segment + - `--nice, -e`: Controls of maximum nice priority - `--file-size, -f`: Maximum size of files created by the shell + - `--pending-signals, -i`: Maximum number of pending signals + - `--lock-size, -l`: Maximum size that may be locked into memory + - `--resident-set-size, -m`: Maximum resident set size - `--file-descriptor-count, -n`: Maximum number of open file descriptors + - `--queue-size, -q`: Maximum bytes in POSIX message queues + - `--realtime-priority, -r`: Maximum realtime scheduling priority - `--stack-size, -s`: Maximum stack size - `--cpu-time, -t`: Maximum amount of CPU time in seconds + - `--process-count, -u`: Maximum number of processes available to the current user - `--virtual-memory-size, -v`: Maximum amount of virtual memory available to each process + - `--file-locks, -x`: Maximum number of file locks + - `--realtime-maxtime, -y`: Maximum contiguous realtime CPU time ## Parameters From 5532f9999bc595d3d326e900cf5b057657135df0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Paulie=20Pe=C3=B1a?= <203125+paulie4@users.noreply.github.com> Date: Thu, 5 Dec 2024 16:23:13 -0500 Subject: [PATCH 3/3] Revert "run `make_docs.nu`" This reverts commit ffbe438c9d113a7b15f4fa9ad92b2223eac9433a, since I didn't want that as part of the PR and just wanted it so people can see the results of running `make_docs.nu` --- .vuepress/configs/sidebar/command_categories.ts | 7 ++++++- commands/docs/cal.md | 6 +++--- commands/docs/collect.md | 2 +- commands/docs/cp.md | 4 ++-- commands/docs/decode_base32.md | 2 +- commands/docs/decode_base32hex.md | 2 +- commands/docs/decode_base64.md | 4 ++-- commands/docs/def.md | 4 ++-- commands/docs/detect_columns.md | 2 +- commands/docs/do.md | 2 +- commands/docs/encode_base32.md | 2 +- commands/docs/encode_base32hex.md | 2 +- commands/docs/encode_base64.md | 4 ++-- commands/docs/encode_hex.md | 2 +- commands/docs/explore.md | 2 +- commands/docs/export_def.md | 4 ++-- commands/docs/from.md | 5 +++++ commands/docs/from_csv.md | 4 ++-- commands/docs/from_msgpack.md | 2 +- commands/docs/from_msgpackz.md | 2 +- commands/docs/from_tsv.md | 4 ++-- commands/docs/from_xml.md | 4 ++-- commands/docs/group-by.md | 2 +- commands/docs/into_datetime.md | 4 ++-- commands/docs/mktemp.md | 2 +- commands/docs/move.md | 4 ++-- commands/docs/plugin_add.md | 2 +- commands/docs/plugin_list.md | 2 +- commands/docs/plugin_rm.md | 2 +- commands/docs/plugin_use.md | 2 +- commands/docs/rotate.md | 2 +- commands/docs/str_expand.md | 2 +- commands/docs/table.md | 4 ++-- commands/docs/to.md | 1 + commands/docs/to_csv.md | 2 +- commands/docs/to_tsv.md | 2 +- commands/docs/ulimit.md | 9 --------- 37 files changed, 58 insertions(+), 56 deletions(-) diff --git a/.vuepress/configs/sidebar/command_categories.ts b/.vuepress/configs/sidebar/command_categories.ts index e315b4a1607..b396886c265 100644 --- a/.vuepress/configs/sidebar/command_categories.ts +++ b/.vuepress/configs/sidebar/command_categories.ts @@ -5,26 +5,31 @@ export const commandCategories = [ '/commands/categories/conversions.md', '/commands/categories/core.md', '/commands/categories/database.md', + '/commands/categories/dataframe.md', + '/commands/categories/dataframe_or_lazyframe.md', '/commands/categories/date.md', '/commands/categories/debug.md', '/commands/categories/default.md', '/commands/categories/env.md', + '/commands/categories/expression.md', '/commands/categories/filesystem.md', '/commands/categories/filters.md', '/commands/categories/formats.md', '/commands/categories/generators.md', '/commands/categories/hash.md', '/commands/categories/history.md', + '/commands/categories/lazyframe.md', '/commands/categories/math.md', '/commands/categories/misc.md', '/commands/categories/network.md', '/commands/categories/path.md', '/commands/categories/platform.md', '/commands/categories/plugin.md', + '/commands/categories/prompt.md', '/commands/categories/random.md', '/commands/categories/removed.md', '/commands/categories/shells.md', '/commands/categories/strings.md', '/commands/categories/system.md', '/commands/categories/viewers.md', -]; \ No newline at end of file +]; diff --git a/commands/docs/cal.md b/commands/docs/cal.md index 13621891594..54c7140d629 100644 --- 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 index 0a819b37bc3..dba14976631 100644 --- 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 index c09563fb015..9262156512b 100644 --- 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}`: preserve only the specified attributes (empty list means no attributes preserved) + - `--preserve, - {list}`: 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 index b7b78e90283..ea3ab91483c 100644 --- 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 index 5acb5a1793b..528790cd6de 100644 --- 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 index 527ef3e20ac..d1f20df143c 100644 --- 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 index c7a31648101..3ab44494109 100644 --- 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 index 9aed04aa6b9..8d30fc3a120 100644 --- 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 index cf4303b46fa..d6facd4e293 100644 --- 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 index d848b53b711..eadf695ae99 100644 --- 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 index 1cc0ea90a0b..f5b975b5de1 100644 --- 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 index 81950becce4..5080a213a41 100644 --- 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 index 5c06c5586cc..c68c1c4b868 100644 --- 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 index 04ae758c730..d1b4a422e5b 100644 --- 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 index f51ecb981ec..ccf8c5fdaeb 100644 --- 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.md b/commands/docs/from.md index e7fd7bab7ba..060341caac8 100644 --- a/commands/docs/from.md +++ b/commands/docs/from.md @@ -33,15 +33,20 @@ You must use one of the following subcommands. Using this command as-is will onl | name | description | type | | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------- | | [`from csv`](/commands/docs/from_csv.md) | Parse text as .csv and create table. | built-in | +| [`from eml`](/commands/docs/from_eml.md) | Parse text as .eml and create record. | plugin | +| [`from ics`](/commands/docs/from_ics.md) | Parse text as .ics and create table. | plugin | +| [`from ini`](/commands/docs/from_ini.md) | Parse text as .ini and create table. | plugin | | [`from json`](/commands/docs/from_json.md) | Convert from json to structured data. | built-in | | [`from msgpack`](/commands/docs/from_msgpack.md) | Convert MessagePack data into Nu values. | built-in | | [`from msgpackz`](/commands/docs/from_msgpackz.md) | Convert brotli-compressed MessagePack data into Nu values. | built-in | | [`from nuon`](/commands/docs/from_nuon.md) | Convert from nuon to structured data. | built-in | | [`from ods`](/commands/docs/from_ods.md) | Parse OpenDocument Spreadsheet(.ods) data and create table. | built-in | +| [`from plist`](/commands/docs/from_plist.md) | Convert plist to Nushell values | plugin | | [`from ssv`](/commands/docs/from_ssv.md) | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. | built-in | | [`from toml`](/commands/docs/from_toml.md) | Parse text as .toml and create record. | built-in | | [`from tsv`](/commands/docs/from_tsv.md) | Parse text as .tsv and create table. | built-in | | [`from url`](/commands/docs/from_url.md) | Parse url-encoded string as a record. | built-in | +| [`from vcf`](/commands/docs/from_vcf.md) | Parse text as .vcf and create table. | plugin | | [`from xlsx`](/commands/docs/from_xlsx.md) | Parse binary Excel(.xlsx) data and create table. | built-in | | [`from xml`](/commands/docs/from_xml.md) | Parse text as .xml and create record. | built-in | | [`from yaml`](/commands/docs/from_yaml.md) | Parse text as .yaml/.yml and create table. | built-in | diff --git a/commands/docs/from_csv.md b/commands/docs/from_csv.md index 2581535eb34..06dc1f08c79 100644 --- 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 index 5f58a5a0c0a..37d7376c707 100644 --- 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 index 43a53a476d4..bd4d01091fb 100644 --- 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 index 67e4cd5fa00..0ca89a7e502 100644 --- 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 index 971cdfca8d0..248bd7d8058 100644 --- 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 index bf8892fa102..b9cfd0f13db 100644 --- 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 index 40571fb3e3e..945758ca272 100644 --- 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 -0500 (40 years ago) +Fri, 16 Nov 1984 08:00:00 +0800 (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 │ 2 years ago │ +│ 2 │ a year ago │ ╰───┴─────────────╯ ``` diff --git a/commands/docs/mktemp.md b/commands/docs/mktemp.md index 867ea2857b9..13c292cbba9 100644 --- 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 index 849449c7035..f5ae5c05005 100644 --- 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 index a1138f0e984..e40ce500906 100644 --- 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 index 7acd9eba370..d32b1c68b2a 100644 --- 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 index ee103685aff..56479928e91 100644 --- 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 index 57916daba96..b56f14c411f 100644 --- 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/rotate.md b/commands/docs/rotate.md index b394843f6fa..bfefac406e6 100644 --- 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 index 7ca9115540d..3fa1994de36 100644 --- 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 index 83ef33d26aa..d9352b410ce 100644 --- 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.md b/commands/docs/to.md index 27be4ccb5ce..007805955b9 100644 --- a/commands/docs/to.md +++ b/commands/docs/to.md @@ -39,6 +39,7 @@ You must use one of the following subcommands. Using this command as-is will onl | [`to msgpack`](/commands/docs/to_msgpack.md) | Convert Nu values into MessagePack. | built-in | | [`to msgpackz`](/commands/docs/to_msgpackz.md) | Convert Nu values into brotli-compressed MessagePack. | built-in | | [`to nuon`](/commands/docs/to_nuon.md) | Converts table data into Nuon (Nushell Object Notation) text. | built-in | +| [`to plist`](/commands/docs/to_plist.md) | Convert Nu values into plist | plugin | | [`to text`](/commands/docs/to_text.md) | Converts data into simple text. | built-in | | [`to toml`](/commands/docs/to_toml.md) | Convert record into .toml text. | built-in | | [`to tsv`](/commands/docs/to_tsv.md) | Convert table into .tsv text. | built-in | diff --git a/commands/docs/to_csv.md b/commands/docs/to_csv.md index 2948bf77bf1..5d2b31a7db2 100644 --- 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}`: the names (in order) of the columns to use + - `--columns, - {list}`: 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 index b374c58043c..f10e408cc95 100644 --- 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}`: the names (in order) of the columns to use + - `--columns, - {list}`: the names (in order) of the columns to use ## Input/output types: diff --git a/commands/docs/ulimit.md b/commands/docs/ulimit.md index 44960660480..876fafab16d 100644 --- a/commands/docs/ulimit.md +++ b/commands/docs/ulimit.md @@ -25,20 +25,11 @@ usage: | - `--all, -a`: Prints all current limits - `--core-size, -c`: Maximum size of core files created - `--data-size, -d`: Maximum size of a process's data segment - - `--nice, -e`: Controls of maximum nice priority - `--file-size, -f`: Maximum size of files created by the shell - - `--pending-signals, -i`: Maximum number of pending signals - - `--lock-size, -l`: Maximum size that may be locked into memory - - `--resident-set-size, -m`: Maximum resident set size - `--file-descriptor-count, -n`: Maximum number of open file descriptors - - `--queue-size, -q`: Maximum bytes in POSIX message queues - - `--realtime-priority, -r`: Maximum realtime scheduling priority - `--stack-size, -s`: Maximum stack size - `--cpu-time, -t`: Maximum amount of CPU time in seconds - - `--process-count, -u`: Maximum number of processes available to the current user - `--virtual-memory-size, -v`: Maximum amount of virtual memory available to each process - - `--file-locks, -x`: Maximum number of file locks - - `--realtime-maxtime, -y`: Maximum contiguous realtime CPU time ## Parameters