Enforce required, optional, and rest positional arguments start with an uppercase and end with a period. (#11285)

# Description

This updates all the positional arguments (except with
`--features=dataframe` or `--features=extra`) to start with an uppercase
letter and end with a period.

Part of #5066, specifically [this
comment](/nushell/nushell/issues/5066#issuecomment-1421528910)

Some arguments had example data removed from them because it also
appears in the examples.

There are other inconsistencies in positional arguments I noticed while
making the tests pass which I will bring up in #5066.

# User-Facing Changes

Positional arguments are now consistent

# Tests + Formatting

- 🟢 `toolkit fmt`
- 🟢 `toolkit clippy`
- 🟢 `toolkit test`
- 🟢 `toolkit test stdlib`

# After Submitting

Automatic documentation updates
This commit is contained in:
Eric Hodel
2023-12-14 22:32:37 -08:00
committed by GitHub
parent c2b684464f
commit 5b01685fc3
196 changed files with 383 additions and 281 deletions

View File

@ -27,7 +27,7 @@ impl Command for SubCommand {
.required(
"URL",
SyntaxShape::String,
"the URL to fetch the contents from",
"The URL to fetch the contents from.",
)
.named(
"user",

View File

@ -27,7 +27,7 @@ impl Command for SubCommand {
.required(
"URL",
SyntaxShape::String,
"the URL to fetch the contents from",
"The URL to fetch the contents from.",
)
.named(
"user",

View File

@ -28,7 +28,7 @@ impl Command for SubCommand {
.required(
"URL",
SyntaxShape::String,
"the URL to fetch the contents from",
"The URL to fetch the contents from.",
)
.named(
"user",

View File

@ -27,7 +27,7 @@ impl Command for SubCommand {
.required(
"URL",
SyntaxShape::String,
"the URL to fetch the options from",
"The URL to fetch the options from.",
)
.named(
"user",

View File

@ -24,8 +24,8 @@ impl Command for SubCommand {
Signature::build("http patch")
.input_output_types(vec![(Type::Nothing, Type::Any)])
.allow_variants_without_examples(true)
.required("URL", SyntaxShape::String, "the URL to post to")
.required("data", SyntaxShape::Any, "the contents of the post body")
.required("URL", SyntaxShape::String, "The URL to post to.")
.required("data", SyntaxShape::Any, "The contents of the post body.")
.named(
"user",
SyntaxShape::Any,

View File

@ -24,8 +24,8 @@ impl Command for SubCommand {
Signature::build("http post")
.input_output_types(vec![(Type::Nothing, Type::Any)])
.allow_variants_without_examples(true)
.required("URL", SyntaxShape::String, "the URL to post to")
.required("data", SyntaxShape::Any, "the contents of the post body")
.required("URL", SyntaxShape::String, "The URL to post to.")
.required("data", SyntaxShape::Any, "The contents of the post body.")
.named(
"user",
SyntaxShape::Any,

View File

@ -24,8 +24,8 @@ impl Command for SubCommand {
Signature::build("http put")
.input_output_types(vec![(Type::Nothing, Type::Any)])
.allow_variants_without_examples(true)
.required("URL", SyntaxShape::String, "the URL to post to")
.required("data", SyntaxShape::Any, "the contents of the post body")
.required("URL", SyntaxShape::String, "The URL to post to.")
.required("data", SyntaxShape::Any, "The contents of the post body.")
.named(
"user",
SyntaxShape::Any,

View File

@ -22,9 +22,9 @@ impl Command for SubCommand {
.optional(
"start",
SyntaxShape::Int,
"The start port to scan (inclusive)",
"The start port to scan (inclusive).",
)
.optional("end", SyntaxShape::Int, "The end port to scan (inclusive)")
.optional("end", SyntaxShape::Int, "The end port to scan (inclusive).")
.category(Category::Network)
}

View File

@ -29,7 +29,7 @@ impl Command for SubCommand {
.rest(
"rest",
SyntaxShape::CellPath,
"For a data structure input, url decode strings at the given cell paths",
"For a data structure input, url decode strings at the given cell paths.",
)
.category(Category::Strings)
}

View File

@ -31,7 +31,7 @@ impl Command for SubCommand {
.rest(
"rest",
SyntaxShape::CellPath,
"For a data structure input, check strings at the given cell paths, and replace with result",
"For a data structure input, check strings at the given cell paths, and replace with result.",
)
.category(Category::Strings)
}

View File

@ -26,7 +26,7 @@ impl Command for SubCommand {
.rest(
"rest",
SyntaxShape::CellPath,
"optionally operate by cell path",
"Optionally operate by cell path.",
)
.category(Category::Network)
}