nushell

mirror of https://github.com/nushell/nushell.git synced 2025-05-07 00:12:58 +00:00

History

Stefan Holderbach 95b78eee25

Change the usage misnomer to "description" (#13598 )

# Description
    
The meaning of the word usage is specific to describing how a command
function is *used* and not a synonym for general description. Usage can
be used to describe the SYNOPSIS or EXAMPLES sections of a man page
where the permitted argument combinations are shown or example *uses*
are given.
Let's not confuse people and call it what it is a description.

Our `help` command already creates its own *Usage* section based on the
available arguments and doesn't refer to the description with usage.

# User-Facing Changes

`help commands` and `scope commands` will now use `description` or
`extra_description`
`usage`-> `description`
`extra_usage` -> `extra_description`

Breaking change in the plugin protocol:

In the signature record communicated with the engine.
`usage`-> `description`
`extra_usage` -> `extra_description`

The same rename also takes place for the methods on
`SimplePluginCommand` and `PluginCommand`

# Tests + Formatting
- Updated plugin protocol specific changes
# After Submitting
- [ ] update plugin protocol doc

2024-08-22 12:02:08 +02:00

assignment

Match ++= capabilities with ++ (#11130 )

2023-12-07 05:46:37 +08:00

bytes

Add string/binary type color to ByteStream (#12897 )

2024-05-20 00:35:32 +00:00

conversions

Change behavior of into record on lists to be more useful (#13637 )

2024-08-22 11:38:43 +02:00

database

Path migration part 4: various tests (#13373 )

2024-08-03 10:09:13 +02:00

date

fix format date based on users locale (#11908 )

2024-02-20 11:08:49 -06:00

debug

Force timeit to not capture stdout (#12465 )

2024-04-10 13:31:29 +00:00

hash_

Bump base64 to 0.22.1 (#12757 )

2024-05-04 15:56:16 +03:00

math

Make the math commands const (#13566 )

2024-08-07 22:20:33 +02:00

move_

Path migration part 4: various tests (#13373 )

2024-08-03 10:09:13 +02:00

network

Fallback to extension-based content type detection when parsing Content-Type header fails (#13610 )

2024-08-14 09:47:01 -05:00

path

Path migration part 4: various tests (#13373 )

2024-08-03 10:09:13 +02:00

platform

refactor: move du from platform to filesystem (#11852 )

2024-02-15 06:55:21 +08:00

query

Feature cleanup (#7182 )

2022-11-22 16:58:11 -08:00

random

Clippy fixes from stable and nightly (#13455 )

2024-07-31 20:37:40 +02:00

skip

Add string/binary type color to ByteStream (#12897 )

2024-05-20 00:35:32 +00:00

str_

Improves commands that support range input (#13113 )

2024-06-18 07:19:13 -05:00

take

Add string/binary type color to ByteStream (#12897 )

2024-05-20 00:35:32 +00:00

url

Allow 'url join' to print username without password (#11697 )

2024-01-31 16:52:23 -06:00

alias.rs

Avoid taking unnecessary ownership of intermediates (#12740 )

2024-05-04 00:53:15 +00:00

all.rs

Rewrite run_external.rs (#12921 )

2024-05-23 02:05:27 +00:00

any.rs

Rewrite run_external.rs (#12921 )

2024-05-23 02:05:27 +00:00

append.rs

fix(nu-command/tests): further remove unnecessary pipeline() and cwd() (#8793 )

2023-04-07 14:09:55 -07:00

break_.rs

don't allow break/continue in each and items command (#13398 )

2024-07-19 00:21:02 -07:00

cal.rs

Suppress column index for default cal output (#13188 )

2024-06-22 07:41:29 -05:00

cd.rs

Path migration part 4: various tests (#13373 )

2024-08-03 10:09:13 +02:00

chunks.rs

Deprecate group in favor of chunks (#13377 )

2024-07-16 03:49:00 +00:00

compact.rs

Remove file I/O from tests that don't need it (#11182 )

2023-11-29 23:21:34 +01:00

complete.rs

Make assignment and const consistent with let/mut (#13385 )

2024-07-30 18:55:22 -05:00

config_env_default.rs

Command: Add config env/nu --default to print defaults (#10480 )

2023-09-25 08:00:59 -05:00

config_nu_default.rs

Command: Add config env/nu --default to print defaults (#10480 )

2023-09-25 08:00:59 -05:00

continue_.rs

fix(nu-command/tests): further remove unnecessary pipeline() and cwd() (#8793 )

2023-04-07 14:09:55 -07:00

debug_info.rs

Make debug info lazy (#10728 )

2023-10-24 12:48:05 -05:00

def.rs

Remove --flag: bool support (#11541 )

2024-01-25 14:16:49 +08:00

default.rs

Remove default list-diving behaviour (#13386 )

2024-07-16 03:54:24 +00:00

detect_columns.rs

Improves commands that support range input (#13113 )

2024-06-18 07:19:13 -05:00

do_.rs

allow define it as a variable inside closure (#12888 )

2024-05-17 00:03:13 +00:00

drop.rs

Refactor drop columns to fix issues (#10903 )

2023-11-09 13:51:46 +01:00

du.rs

Avoid taking unnecessary ownership of intermediates (#12740 )

2024-05-04 00:53:15 +00:00

each.rs

don't allow break/continue in each and items command (#13398 )

2024-07-19 00:21:02 -07:00

echo.rs

Change echo to print when not redirected (#10338 )

2023-09-13 06:35:01 +12:00

empty.rs

fix(nu-command/tests): further remove unnecessary pipeline() and cwd() (#8793 )

2023-04-07 14:09:55 -07:00

error_make.rs

Change the error style during tests to plain (#13061 )

2024-06-18 21:37:24 -07:00

every.rs

Avoid taking unnecessary ownership of intermediates (#12740 )

2024-05-04 00:53:15 +00:00

exec.rs

Isolate tests from user config (#12437 )

2024-04-10 06:27:46 +08:00

export_def.rs

Removes unnecessary cwd and pipeline from various tests (#9202 )

2023-05-17 18:55:26 -05:00

fill.rs

Removes unnecessary cwd and pipeline from various tests (#9202 )

2023-05-17 18:55:26 -05:00

filter.rs

Fix return in filter closure eval (#12292 )

2024-03-26 17:50:36 +01:00

find.rs

Fix find command output bug in the case of taking ByteStream input. (#13246 )

2024-06-27 09:46:10 -05:00

first.rs

Add string/binary type color to ByteStream (#12897 )

2024-05-20 00:35:32 +00:00

flatten.rs

Remove file I/O from tests that don't need it (#11182 )

2023-11-29 23:21:34 +01:00

for_.rs

Change echo to print when not redirected (#10338 )

2023-09-13 06:35:01 +12:00

format.rs

Span ID Refactor (Step 2): Use SpanId of expressions in some places (#13102 )

2024-06-09 12:15:53 +03:00

generate.rs

generate: switch the position of <initial> and <closure>, so the closure can have default parameters (#13393 )

2024-07-19 00:22:28 -07:00

get.rs

Avoid taking unnecessary ownership of intermediates (#12740 )

2024-05-04 00:53:15 +00:00

glob.rs

Avoid taking unnecessary ownership of intermediates (#12740 )

2024-05-04 00:53:15 +00:00

griddle.rs

make grid throw an error when not enough columns (#12672 )

2024-04-26 06:33:00 -05:00

group_by.rs

Make group-by return errors in closure (#12508 )

2024-04-16 21:52:21 +02:00

headers.rs

Fix: remove unnecessary r#"..."# (#8670 ) (#9764 )

2023-07-21 17:32:37 +02:00

help.rs

Change the usage misnomer to "description" (#13598 )

2024-08-22 12:02:08 +02:00

histogram.rs

Remove file I/O from tests that don't need it (#11182 )

2023-11-29 23:21:34 +01:00

ignore.rs

Change the ignore command to use drain() instead of collecting a value (#12120 )

2024-03-08 02:18:26 -05:00

insert.rs

Remove lazy records (#12682 )

2024-05-03 08:36:10 +08:00

inspect.rs

throw an error instead of a panic if no input is provided to inspect (#9259 )

2023-05-22 13:54:04 -05:00

interleave.rs

Isolate tests from user config (#12437 )

2024-04-10 06:27:46 +08:00

into_datetime.rs

add table -> table to into datetime (#9775 )

2023-07-23 20:14:51 +02:00

into_filesize.rs

fix wrong casting with into filesize (#13110 )

2024-06-10 10:43:17 +08:00

into_int.rs

add --signed flag for binary into int conversions (#11902 )

2024-02-27 15:05:26 +00:00

join.rs

Removes unnecessary cwd and pipeline from various tests (#9202 )

2023-05-17 18:55:26 -05:00

last.rs

Add string/binary type color to ByteStream (#12897 )

2024-05-20 00:35:32 +00:00

length.rs

Suppress column index for default cal output (#13188 )

2024-06-22 07:41:29 -05:00

let_.rs

Make assignment and const consistent with let/mut (#13385 )

2024-07-30 18:55:22 -05:00

lines.rs

fix panic with lines on an error (#9967 )

2023-08-09 14:12:58 +02:00

loop_.rs

Change echo to print when not redirected (#10338 )

2023-09-13 06:35:01 +12:00

ls.rs

make ls -lf outputs full path in symbolic target (#13605 )

2024-08-13 06:34:10 -05:00

match_.rs

Allow comments in match blocks (#11717 )

2024-02-08 07:22:42 +08:00

merge.rs

Remove file I/O from tests that don't need it (#11182 )

2023-11-29 23:21:34 +01:00

mktemp.rs

Path migration part 4: various tests (#13373 )

2024-08-03 10:09:13 +02:00

mod.rs

Refactor window (#13401 )

2024-07-19 04:16:09 +00:00

mut_.rs

add raw-string literal support (#9956 )

2024-05-02 09:36:37 -04:00

nu_check.rs

Avoid taking unnecessary ownership of intermediates (#12740 )

2024-05-04 00:53:15 +00:00

open.rs

Attempt to guess the content type of a file when opening with --raw (#13521 )

2024-08-06 11:36:24 +02:00

par_each.rs

Fix: remove unnecessary r#"..."# (#8670 ) (#9764 )

2023-07-21 17:32:37 +02:00

parse.rs

Avoid taking unnecessary ownership of intermediates (#12740 )

2024-05-04 00:53:15 +00:00

prepend.rs

Avoid taking unnecessary ownership of intermediates (#12740 )

2024-05-04 00:53:15 +00:00

print.rs

Add --raw switch to print for binary data (#13597 )

2024-08-12 17:29:25 +08:00

range.rs

Avoid taking unnecessary ownership of intermediates (#12740 )

2024-05-04 00:53:15 +00:00

redirection.rs

Overhaul $in expressions (#13357 )

2024-07-17 16:02:42 -05:00

reduce.rs

Improve with-env robustness (#12523 )

2024-04-16 19:08:58 +08:00

reject.rs

Remove list of cell path support for select and reject (#11859 )

2024-02-15 07:49:48 -06:00

rename.rs

Remove file I/O from tests that don't need it (#11182 )

2023-11-29 23:21:34 +01:00

return_.rs

Isolate tests from user config (#12437 )

2024-04-10 06:27:46 +08:00

reverse.rs

Clean up tests containing unnecessary cwd: tokens (#9692 )

2023-07-17 18:43:51 +02:00

rm.rs

Path migration part 4: various tests (#13373 )

2024-08-03 10:09:13 +02:00

roll.rs

Fix: remove unnecessary r#"..."# (#8670 ) (#9764 )

2023-07-21 17:32:37 +02:00

rotate.rs

Fix panic in rotate; Add safe record creation function (#11718 )

2024-02-03 13:23:16 +02:00

run_external.rs

Switch from dirs_next 2.0 to dirs 5.0 (#13384 )

2024-07-16 07:16:26 -05:00

save.rs

save: print to stderr for bytestream (#13422 )

2024-07-31 18:19:35 +02:00

select.rs

Fix select cell path renaming behavior (#13361 )

2024-07-13 16:54:34 +02:00

semicolon.rs

Slim down tests (#9021 )

2023-04-28 13:25:44 +02:00

seq_char.rs

Slim down tests (#9021 )

2023-04-28 13:25:44 +02:00

seq_date.rs

Fix panic in seq date (#11871 )

2024-02-17 10:51:20 +02:00

seq.rs

Slim down tests (#9021 )

2023-04-28 13:25:44 +02:00

sort_by.rs

to json -r not removing whitespaces fix (#11948 )

2024-03-20 22:14:31 +01:00

sort.rs

Fix: remove unnecessary r#"..."# (#8670 ) (#9764 )

2023-07-21 17:32:37 +02:00

source_env.rs

Path migration part 2: nu-test-support (#13329 )

2024-07-12 02:43:10 +00:00

split_by.rs

Avoid taking unnecessary ownership of intermediates (#12740 )

2024-05-04 00:53:15 +00:00

split_column.rs

Avoid taking unnecessary ownership of intermediates (#12740 )

2024-05-04 00:53:15 +00:00

split_row.rs

Avoid taking unnecessary ownership of intermediates (#12740 )

2024-05-04 00:53:15 +00:00

table.rs

Make assignment and const consistent with let/mut (#13385 )

2024-07-30 18:55:22 -05:00

tee.rs

Add tee command for operating on copies of streams (#11928 )

2024-02-28 17:08:31 -06:00

terminal.rs

Add is-terminal to determine if stdin/out/err are a terminal (#10970 )

2023-11-21 20:48:39 -06:00

to_text.rs

Make to text stream ListStreams (#7577 )

2022-12-22 16:38:07 -08:00

touch.rs

Path migration part 4: various tests (#13373 )

2024-08-03 10:09:13 +02:00

transpose.rs

Slim down tests (#9021 )

2023-04-28 13:25:44 +02:00

try_.rs

Make exit code available in catch block (#12648 )

2024-04-26 16:35:08 +00:00

ucp.rs

Path migration part 4: various tests (#13373 )

2024-08-03 10:09:13 +02:00

ulimit.rs

FreeBSD compatibility patches (#11869 )

2024-02-17 20:04:59 +01:00

umkdir.rs

Path migration part 4: various tests (#13373 )

2024-08-03 10:09:13 +02:00

uname.rs

Initial implementation for uutils uname (#11684 )

2024-03-25 16:51:50 -05:00

uniq_by.rs

Remove file I/O from tests that don't need it (#11182 )

2023-11-29 23:21:34 +01:00

uniq.rs

Remove file I/O from tests that don't need it (#11182 )

2023-11-29 23:21:34 +01:00

update.rs

Remove lazy records (#12682 )

2024-05-03 08:36:10 +08:00

upsert.rs

Remove lazy records (#12682 )

2024-05-03 08:36:10 +08:00

use_.rs

Path migration part 2: nu-test-support (#13329 )

2024-07-12 02:43:10 +00:00

where_.rs

Fix ignored clippy lints (#12160 )

2024-03-11 19:46:04 +01:00

which.rs

change the output of which to be more explicit (#9646 )

2023-07-20 19:10:53 -05:00

while_.rs

Change echo to print when not redirected (#10338 )

2023-09-13 06:35:01 +12:00

window.rs

Refactor window (#13401 )

2024-07-19 04:16:09 +00:00

with_env.rs

Improve with-env robustness (#12523 )

2024-04-16 19:08:58 +08:00

wrap.rs

Remove file I/O from tests that don't need it (#11182 )

2023-11-29 23:21:34 +01:00

zip.rs

Avoid taking unnecessary ownership of intermediates (#12740 )

2024-05-04 00:53:15 +00:00