nushell/crates/nu-command/src
Stefan Holderbach 438062d7fc
Document and critically review ShellError variants - Ep. 1 (#8229)
# Description

The `ShellError` enum at the moment is kind of messy. 

Many variants are basic tuple structs where you always have to reference
the implementation with its macro invocation to know which field serves
which purpose.
Furthermore we have both variants that are kind of redundant or either
overly broad to be useful for the user to match on or overly specific
with few uses.

So I set out to start fixing the lacking documentation and naming to
make it feasible to critically review the individual usages and fix
those.
Furthermore we can decide to join or split up variants that don't seem
to be fit for purpose.

Feel free to add review comments if you spot inconsistent use of
`ShellError` variants.

- Name fields on `ShellError::OperatorOverflow`
- Name fields on `ShellError::PipelineMismatch`
- Add doc to `ShellError::OnlySupportsThisInputType`
- Name `ShellError::OnlySupportsThisInputType`
- Name field on `ShellError::PipelineEmpty`
- Comment about issues with `TypeMismatch*`
- Fix a few `exp_input_type`s
- Name fields on `ShellError::InvalidRange`

# User-Facing Changes

(None now, end goal more explicit and consistent error messages)

# Tests + Formatting

(No additional tests needed so far)
2023-03-01 20:34:48 +01:00
..
bits Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
bytes Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
charting Use variable names directly in the format strings (#7906) 2023-01-29 19:37:54 -06:00
conversions Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
database Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
dataframe Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
date Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
debug Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
deprecated Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
env Remove the 'env' command, as we have the variable (#8185) 2023-03-01 21:20:00 +13:00
experimental Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
filesystem Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
filters Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
formats Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
generators Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
hash Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
math Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
misc Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
network Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
path Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
platform Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
random Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
shells Add more input/output type annotations (#7532) 2022-12-21 20:20:46 +01:00
strings Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
system Fix CPU frequency in sys output (#8275) 2023-03-01 21:31:05 +13:00
viewers Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
default_context.rs Remove the 'env' command, as we have the variable (#8185) 2023-03-01 21:20:00 +13:00
example_test.rs cratification: Example support (#8231) 2023-02-27 13:58:56 -08:00
input_handler.rs Standardise the use of ShellError::UnsupportedInput and ShellError::TypeMismatch and add spans to every instance of the former (#7217) 2022-12-23 01:48:53 -05:00
lib.rs Cratification: Break out nu_cmd_lang into a separate crate (#8181) 2023-02-24 09:54:42 -06:00
progress_bar.rs cp progress bar implementation (#8012) 2023-02-22 11:57:38 -08:00
sort_utils.rs Reduce again the number of match calls (#7815) 2023-01-24 12:23:42 +01:00