nushell/crates/nu-command/src/strings
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
..
encode_decode Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
format Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
split Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
str_ Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
char_.rs Use imported names in Command::run signatures (#7967) 2023-02-05 22:17:46 +01:00
detect_columns.rs Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
mod.rs Add Github Actions workflow to check for typos (#7892) 2023-01-29 10:22:56 +13:00
parse.rs Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00
size.rs Document and critically review ShellError variants - Ep. 1 (#8229) 2023-03-01 20:34:48 +01:00