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:
Stefan Holderbach
2024-08-22 12:02:08 +02:00
committed by GitHub
parent 3ab9f0b90a
commit 95b78eee25
597 changed files with 1085 additions and 1039 deletions

View File

@ -82,11 +82,11 @@ impl Command for SubCommand {
.category(Category::Network)
}
fn usage(&self) -> &str {
fn description(&self) -> &str {
"Delete the specified resource."
}
fn extra_usage(&self) -> &str {
fn extra_description(&self) -> &str {
"Performs HTTP DELETE operation."
}

View File

@ -78,11 +78,11 @@ impl Command for SubCommand {
.category(Category::Network)
}
fn usage(&self) -> &str {
fn description(&self) -> &str {
"Fetch the contents from a URL."
}
fn extra_usage(&self) -> &str {
fn extra_description(&self) -> &str {
"Performs HTTP GET operation."
}

View File

@ -62,11 +62,11 @@ impl Command for SubCommand {
.category(Category::Network)
}
fn usage(&self) -> &str {
fn description(&self) -> &str {
"Get the headers from a URL."
}
fn extra_usage(&self) -> &str {
fn extra_description(&self) -> &str {
"Performs HTTP HEAD operation."
}

View File

@ -14,11 +14,11 @@ impl Command for Http {
.category(Category::Network)
}
fn usage(&self) -> &str {
fn description(&self) -> &str {
"Various commands for working with http methods."
}
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."
}

View File

@ -61,11 +61,11 @@ impl Command for SubCommand {
.category(Category::Network)
}
fn usage(&self) -> &str {
fn description(&self) -> &str {
"Requests permitted communication options for a given URL."
}
fn extra_usage(&self) -> &str {
fn extra_description(&self) -> &str {
"Performs an HTTP OPTIONS request. Most commonly used for making CORS preflight requests."
}

View File

@ -78,11 +78,11 @@ impl Command for SubCommand {
.category(Category::Network)
}
fn usage(&self) -> &str {
fn description(&self) -> &str {
"Patch a body to a URL."
}
fn extra_usage(&self) -> &str {
fn extra_description(&self) -> &str {
"Performs HTTP PATCH operation."
}

View File

@ -78,11 +78,11 @@ impl Command for SubCommand {
.category(Category::Network)
}
fn usage(&self) -> &str {
fn description(&self) -> &str {
"Post a body to a URL."
}
fn extra_usage(&self) -> &str {
fn extra_description(&self) -> &str {
"Performs HTTP POST operation."
}

View File

@ -78,11 +78,11 @@ impl Command for SubCommand {
.category(Category::Network)
}
fn usage(&self) -> &str {
fn description(&self) -> &str {
"Put a body to a URL."
}
fn extra_usage(&self) -> &str {
fn extra_description(&self) -> &str {
"Performs HTTP PUT operation."
}

View File

@ -22,7 +22,7 @@ impl Command for SubCommand {
.category(Category::Network)
}
fn usage(&self) -> &str {
fn description(&self) -> &str {
"Get a free port from system."
}

View File

@ -17,7 +17,7 @@ impl Command for SubCommand {
.category(Category::Network)
}
fn usage(&self) -> &str {
fn description(&self) -> &str {
"Converts record or table into query string applying percent-encoding."
}

View File

@ -31,7 +31,7 @@ impl Command for SubCommand {
.category(Category::Strings)
}
fn usage(&self) -> &str {
fn description(&self) -> &str {
"Converts a percent-encoded web safe string to a string."
}

View File

@ -32,7 +32,7 @@ impl Command for SubCommand {
.category(Category::Strings)
}
fn usage(&self) -> &str {
fn description(&self) -> &str {
"Converts a string to a percent encoded web safe string."
}

View File

@ -14,7 +14,7 @@ impl Command for SubCommand {
.category(Category::Network)
}
fn usage(&self) -> &str {
fn description(&self) -> &str {
"Converts a record to url."
}

View File

@ -26,7 +26,7 @@ impl Command for SubCommand {
.category(Category::Network)
}
fn usage(&self) -> &str {
fn description(&self) -> &str {
"Parses a url."
}

View File

@ -14,11 +14,11 @@ impl Command for Url {
.category(Category::Network)
}
fn usage(&self) -> &str {
fn description(&self) -> &str {
"Various commands for working with URLs."
}
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."
}