mirror of
https://github.com/nushell/nushell.git
synced 2025-08-12 19:47:56 +02:00
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
This commit is contained in:
committed by
GitHub
parent
3ab9f0b90a
commit
95b78eee25
@ -51,7 +51,7 @@ impl Command for BytesAdd {
|
||||
.category(Category::Bytes)
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
fn description(&self) -> &str {
|
||||
"Add specified bytes to the input."
|
||||
}
|
||||
|
||||
|
@ -53,7 +53,7 @@ impl Command for BytesAt {
|
||||
.category(Category::Bytes)
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
fn description(&self) -> &str {
|
||||
"Get bytes defined by a range."
|
||||
}
|
||||
|
||||
|
@ -8,7 +8,7 @@ impl Command for BytesBuild {
|
||||
"bytes build"
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
fn description(&self) -> &str {
|
||||
"Create bytes from the arguments."
|
||||
}
|
||||
|
||||
|
@ -14,11 +14,11 @@ impl Command for Bytes {
|
||||
.input_output_types(vec![(Type::Nothing, Type::String)])
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
fn description(&self) -> &str {
|
||||
"Various commands for working with byte data."
|
||||
}
|
||||
|
||||
fn extra_usage(&self) -> &str {
|
||||
fn extra_description(&self) -> &str {
|
||||
"You must use one of the following subcommands. Using this command as-is will only produce this help message."
|
||||
}
|
||||
|
||||
|
@ -20,7 +20,7 @@ impl Command for BytesCollect {
|
||||
.category(Category::Bytes)
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
fn description(&self) -> &str {
|
||||
"Concatenate multiple binary into a single binary, with an optional separator between each."
|
||||
}
|
||||
|
||||
|
@ -41,7 +41,7 @@ impl Command for BytesEndsWith {
|
||||
.category(Category::Bytes)
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
fn description(&self) -> &str {
|
||||
"Check if bytes ends with a pattern."
|
||||
}
|
||||
|
||||
|
@ -47,7 +47,7 @@ impl Command for BytesIndexOf {
|
||||
.category(Category::Bytes)
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
fn description(&self) -> &str {
|
||||
"Returns start index of first occurrence of pattern in bytes, or -1 if no match."
|
||||
}
|
||||
|
||||
|
@ -29,7 +29,7 @@ impl Command for BytesLen {
|
||||
.category(Category::Bytes)
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
fn description(&self) -> &str {
|
||||
"Output the length of any bytes in the pipeline."
|
||||
}
|
||||
|
||||
|
@ -40,7 +40,7 @@ impl Command for BytesRemove {
|
||||
.category(Category::Bytes)
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
fn description(&self) -> &str {
|
||||
"Remove bytes."
|
||||
}
|
||||
|
||||
|
@ -41,7 +41,7 @@ impl Command for BytesReplace {
|
||||
.category(Category::Bytes)
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
fn description(&self) -> &str {
|
||||
"Find and replace binary."
|
||||
}
|
||||
|
||||
|
@ -25,7 +25,7 @@ impl Command for BytesReverse {
|
||||
.category(Category::Bytes)
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
fn description(&self) -> &str {
|
||||
"Reverse the bytes in the pipeline."
|
||||
}
|
||||
|
||||
|
@ -39,7 +39,7 @@ impl Command for BytesStartsWith {
|
||||
.category(Category::Bytes)
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
fn description(&self) -> &str {
|
||||
"Check if bytes starts with a pattern."
|
||||
}
|
||||
|
||||
|
Reference in New Issue
Block a user