Uniformize usage() and extra_usage() message ending for commands helper. (#8268)

# Description

Working on uniformizing the ending messages regarding methods usage()
and extra_usage(). This is related to the issue
https://github.com/nushell/nushell/issues/5066 after discussing it with
@jntrnr

# User-Facing Changes

None.

# Tests + Formatting

Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass

# After Submitting

If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
This commit is contained in:
Jérémy Audiger 2023-03-01 06:33:02 +01:00 committed by GitHub
parent 644164fab3
commit a5c604c283
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
268 changed files with 278 additions and 278 deletions

View File

@ -28,7 +28,7 @@ impl Command for Print {
}
fn usage(&self) -> &str {
"Print the given values to stdout"
"Print the given values to stdout."
}
fn extra_usage(&self) -> &str {

View File

@ -13,7 +13,7 @@ impl Command for Alias {
}
fn usage(&self) -> &str {
"Alias a command (with optional flags) to a new name"
"Alias a command (with optional flags) to a new name."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -11,7 +11,7 @@ impl Command for Break {
}
fn usage(&self) -> &str {
"Break a loop"
"Break a loop."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -41,7 +41,7 @@ impl Command for Commandline {
}
fn usage(&self) -> &str {
"View or modify the current command line input buffer"
"View or modify the current command line input buffer."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -11,7 +11,7 @@ impl Command for Continue {
}
fn usage(&self) -> &str {
"Continue a loop from the next iteration"
"Continue a loop from the next iteration."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -13,7 +13,7 @@ impl Command for Def {
}
fn usage(&self) -> &str {
"Define a custom command"
"Define a custom command."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -13,7 +13,7 @@ impl Command for DefEnv {
}
fn usage(&self) -> &str {
"Define a custom command, which participates in the caller environment"
"Define a custom command, which participates in the caller environment."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -17,7 +17,7 @@ impl Command for Do {
}
fn usage(&self) -> &str {
"Run a closure, providing it with the pipeline input"
"Run a closure, providing it with the pipeline input."
}
fn signature(&self) -> Signature {

View File

@ -13,7 +13,7 @@ impl Command for ExportAlias {
}
fn usage(&self) -> &str {
"Alias a command (with optional flags) to a new name and export it from a module"
"Alias a command (with optional flags) to a new name and export it from a module."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -13,7 +13,7 @@ impl Command for ExportDef {
}
fn usage(&self) -> &str {
"Define a custom command and export it from a module"
"Define a custom command and export it from a module."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -13,7 +13,7 @@ impl Command for ExportDefEnv {
}
fn usage(&self) -> &str {
"Define a custom command that participates in the environment and export it from a module"
"Define a custom command that participates in the environment and export it from a module."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -11,7 +11,7 @@ impl Command for ExportExtern {
}
fn usage(&self) -> &str {
"Define an extern and export it from a module"
"Define an extern and export it from a module."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -13,7 +13,7 @@ impl Command for ExportUse {
}
fn usage(&self) -> &str {
"Use definitions from a module and export them from this module"
"Use definitions from a module and export them from this module."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -11,7 +11,7 @@ impl Command for Extern {
}
fn usage(&self) -> &str {
"Define a signature for an external command"
"Define a signature for an external command."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -14,7 +14,7 @@ impl Command for For {
}
fn usage(&self) -> &str {
"Loop over a range"
"Loop over a range."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -23,7 +23,7 @@ impl Command for Hide {
}
fn usage(&self) -> &str {
"Hide definitions in the current scope"
"Hide definitions in the current scope."
}
fn extra_usage(&self) -> &str {

View File

@ -31,7 +31,7 @@ impl Command for HideEnv {
}
fn usage(&self) -> &str {
"Hide environment variables in the current scope"
"Hide environment variables in the current scope."
}
fn run(

View File

@ -11,7 +11,7 @@ impl Command for Ignore {
}
fn usage(&self) -> &str {
"Ignore the output of the previous command in the pipeline"
"Ignore the output of the previous command in the pipeline."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -13,7 +13,7 @@ impl Command for Module {
}
fn usage(&self) -> &str {
"Define a custom module"
"Define a custom module."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -14,7 +14,7 @@ impl Command for OverlayHide {
}
fn usage(&self) -> &str {
"Hide an active overlay"
"Hide an active overlay."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -13,7 +13,7 @@ impl Command for OverlayList {
}
fn usage(&self) -> &str {
"List all active overlays"
"List all active overlays."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -14,7 +14,7 @@ impl Command for OverlayNew {
}
fn usage(&self) -> &str {
"Create an empty overlay"
"Create an empty overlay."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -17,7 +17,7 @@ impl Command for OverlayUse {
}
fn usage(&self) -> &str {
"Use definitions from a module as an overlay"
"Use definitions from a module as an overlay."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -11,7 +11,7 @@ impl Command for Register {
}
fn usage(&self) -> &str {
"Register a plugin"
"Register a plugin."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -14,7 +14,7 @@ impl Command for Return {
}
fn usage(&self) -> &str {
"Return early from a function"
"Return early from a function."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -15,7 +15,7 @@ impl Command for Try {
}
fn usage(&self) -> &str {
"Try to run a block, if it fails optionally run a catch block"
"Try to run a block, if it fails optionally run a catch block."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -14,7 +14,7 @@ impl Command for Use {
}
fn usage(&self) -> &str {
"Use definitions from a module"
"Use definitions from a module."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -26,7 +26,7 @@ impl Command for SubCommand {
}
fn usage(&self) -> &str {
"Performs bitwise and for integers"
"Performs bitwise and for integers."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -20,7 +20,7 @@ impl Command for Bits {
}
fn usage(&self) -> &str {
"Various commands for working with bits"
"Various commands for working with bits."
}
fn extra_usage(&self) -> &str {

View File

@ -33,7 +33,7 @@ impl Command for SubCommand {
}
fn usage(&self) -> &str {
"Performs logical negation on each bit"
"Performs logical negation on each bit."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -26,7 +26,7 @@ impl Command for SubCommand {
}
fn usage(&self) -> &str {
"Performs bitwise or for integers"
"Performs bitwise or for integers."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -36,7 +36,7 @@ impl Command for SubCommand {
}
fn usage(&self) -> &str {
"Bitwise rotate left for integers"
"Bitwise rotate left for integers."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -36,7 +36,7 @@ impl Command for SubCommand {
}
fn usage(&self) -> &str {
"Bitwise rotate right for integers"
"Bitwise rotate right for integers."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -36,7 +36,7 @@ impl Command for SubCommand {
}
fn usage(&self) -> &str {
"Bitwise shift left for integers"
"Bitwise shift left for integers."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -36,7 +36,7 @@ impl Command for SubCommand {
}
fn usage(&self) -> &str {
"Bitwise shift right for integers"
"Bitwise shift right for integers."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -26,7 +26,7 @@ impl Command for SubCommand {
}
fn usage(&self) -> &str {
"Performs bitwise xor for integers"
"Performs bitwise xor for integers."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -49,7 +49,7 @@ impl Command for BytesAdd {
}
fn usage(&self) -> &str {
"Add specified bytes to the input"
"Add specified bytes to the input."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -20,7 +20,7 @@ impl Command for Bytes {
}
fn usage(&self) -> &str {
"Various commands for working with byte data"
"Various commands for working with byte data."
}
fn extra_usage(&self) -> &str {

View File

@ -26,7 +26,7 @@ impl Command for BytesCollect {
}
fn usage(&self) -> &str {
"Concatenate multiple binary into a single binary, with an optional separator between each"
"Concatenate multiple binary into a single binary, with an optional separator between each."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -39,7 +39,7 @@ impl Command for BytesEndsWith {
}
fn usage(&self) -> &str {
"Check if bytes ends with a pattern"
"Check if bytes ends with a pattern."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -49,7 +49,7 @@ impl Command for BytesIndexOf {
}
fn usage(&self) -> &str {
"Returns start index of first occurrence of pattern in bytes, or -1 if no match"
"Returns start index of first occurrence of pattern in bytes, or -1 if no match."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -27,7 +27,7 @@ impl Command for BytesLen {
}
fn usage(&self) -> &str {
"Output the length of any bytes in the pipeline"
"Output the length of any bytes in the pipeline."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -43,7 +43,7 @@ impl Command for BytesRemove {
}
fn usage(&self) -> &str {
"Remove bytes"
"Remove bytes."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -43,7 +43,7 @@ impl Command for BytesReplace {
}
fn usage(&self) -> &str {
"Find and replace binary"
"Find and replace binary."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -27,7 +27,7 @@ impl Command for BytesReverse {
}
fn usage(&self) -> &str {
"Reverse the bytes in the pipeline"
"Reverse the bytes in the pipeline."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -40,7 +40,7 @@ impl Command for BytesStartsWith {
}
fn usage(&self) -> &str {
"Check if bytes starts with a pattern"
"Check if bytes starts with a pattern."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -37,7 +37,7 @@ impl Command for Fill {
}
fn usage(&self) -> &str {
"Fill and Align"
"Fill and Align."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -15,7 +15,7 @@ impl Command for Fmt {
}
fn usage(&self) -> &str {
"Format a number"
"Format a number."
}
fn signature(&self) -> nu_protocol::Signature {

View File

@ -36,7 +36,7 @@ impl Command for SubCommand {
}
fn usage(&self) -> &str {
"Convert value to a binary primitive"
"Convert value to a binary primitive."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -32,7 +32,7 @@ impl Command for SubCommand {
}
fn usage(&self) -> &str {
"Convert value to boolean"
"Convert value to boolean."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -139,7 +139,7 @@ impl Command for SubCommand {
}
fn usage(&self) -> &str {
"Convert text into a datetime"
"Convert text into a datetime."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -28,7 +28,7 @@ impl Command for SubCommand {
}
fn usage(&self) -> &str {
"Convert text into a decimal"
"Convert text into a decimal."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -39,7 +39,7 @@ impl Command for SubCommand {
}
fn usage(&self) -> &str {
"Convert value to duration"
"Convert value to duration."
}
fn extra_usage(&self) -> &str {

View File

@ -31,7 +31,7 @@ impl Command for SubCommand {
}
fn usage(&self) -> &str {
"Convert value to filesize"
"Convert value to filesize."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -49,7 +49,7 @@ impl Command for SubCommand {
}
fn usage(&self) -> &str {
"Convert value to integer"
"Convert value to integer."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -27,7 +27,7 @@ impl Command for SubCommand {
}
fn usage(&self) -> &str {
"Convert value to record"
"Convert value to record."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -57,7 +57,7 @@ impl Command for SubCommand {
}
fn usage(&self) -> &str {
"Convert value to string"
"Convert value to string."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -48,7 +48,7 @@ impl Command for IntoSqliteDb {
}
fn usage(&self) -> &str {
"Convert table into a SQLite database"
"Convert table into a SQLite database."
}
fn search_terms(&self) -> Vec<&str> {

View File

@ -16,7 +16,7 @@ impl Command for AppendDF {
}
fn usage(&self) -> &str {
"Appends a new dataframe"
"Appends a new dataframe."
}
fn signature(&self) -> Signature {

View File

@ -14,7 +14,7 @@ impl Command for ColumnsDF {
}
fn usage(&self) -> &str {
"Show dataframe columns"
"Show dataframe columns."
}
fn signature(&self) -> Signature {

View File

@ -17,7 +17,7 @@ impl Command for DropDF {
}
fn usage(&self) -> &str {
"Creates a new dataframe by dropping the selected columns"
"Creates a new dataframe by dropping the selected columns."
}
fn signature(&self) -> Signature {

View File

@ -18,7 +18,7 @@ impl Command for DropDuplicates {
}
fn usage(&self) -> &str {
"Drops duplicate values in dataframe"
"Drops duplicate values in dataframe."
}
fn signature(&self) -> Signature {

View File

@ -17,7 +17,7 @@ impl Command for DropNulls {
}
fn usage(&self) -> &str {
"Drops null values in dataframe"
"Drops null values in dataframe."
}
fn signature(&self) -> Signature {

View File

@ -14,7 +14,7 @@ impl Command for DataTypes {
}
fn usage(&self) -> &str {
"Show dataframe data types"
"Show dataframe data types."
}
fn signature(&self) -> Signature {

View File

@ -15,7 +15,7 @@ impl Command for Dummies {
}
fn usage(&self) -> &str {
"Creates a new dataframe with dummy variables"
"Creates a new dataframe with dummy variables."
}
fn signature(&self) -> Signature {

View File

@ -19,7 +19,7 @@ impl Command for FilterWith {
}
fn usage(&self) -> &str {
"Filters dataframe using a mask or expression as reference"
"Filters dataframe using a mask or expression as reference."
}
fn signature(&self) -> Signature {

View File

@ -18,7 +18,7 @@ impl Command for GetDF {
}
fn usage(&self) -> &str {
"Creates dataframe with the selected columns"
"Creates dataframe with the selected columns."
}
fn signature(&self) -> Signature {

View File

@ -15,7 +15,7 @@ impl Command for LastDF {
}
fn usage(&self) -> &str {
"Creates new dataframe with tail rows or creates a last expression"
"Creates new dataframe with tail rows or creates a last expression."
}
fn signature(&self) -> Signature {

View File

@ -15,7 +15,7 @@ impl Command for ListDF {
}
fn usage(&self) -> &str {
"Lists stored dataframes"
"Lists stored dataframes."
}
fn signature(&self) -> Signature {

View File

@ -19,7 +19,7 @@ impl Command for MeltDF {
}
fn usage(&self) -> &str {
"Unpivot a DataFrame from wide to long format"
"Unpivot a DataFrame from wide to long format."
}
fn signature(&self) -> Signature {

View File

@ -22,7 +22,7 @@ impl Command for OpenDataFrame {
}
fn usage(&self) -> &str {
"Opens csv, json, arrow, or parquet file to create dataframe"
"Opens csv, json, arrow, or parquet file to create dataframe."
}
fn signature(&self) -> Signature {

View File

@ -18,7 +18,7 @@ impl Command for RenameDF {
}
fn usage(&self) -> &str {
"Rename a dataframe column"
"Rename a dataframe column."
}
fn signature(&self) -> Signature {

View File

@ -16,7 +16,7 @@ impl Command for SampleDF {
}
fn usage(&self) -> &str {
"Create sample dataframe"
"Create sample dataframe."
}
fn signature(&self) -> Signature {

View File

@ -17,7 +17,7 @@ impl Command for ShapeDF {
}
fn usage(&self) -> &str {
"Shows column and row size for a dataframe"
"Shows column and row size for a dataframe."
}
fn signature(&self) -> Signature {

View File

@ -18,7 +18,7 @@ impl Command for SliceDF {
}
fn usage(&self) -> &str {
"Creates new dataframe from a slice of rows"
"Creates new dataframe from a slice of rows."
}
fn signature(&self) -> Signature {

View File

@ -19,7 +19,7 @@ impl Command for TakeDF {
}
fn usage(&self) -> &str {
"Creates new dataframe using the given indices"
"Creates new dataframe using the given indices."
}
fn signature(&self) -> Signature {

View File

@ -19,7 +19,7 @@ impl Command for ToArrow {
}
fn usage(&self) -> &str {
"Saves dataframe to arrow file"
"Saves dataframe to arrow file."
}
fn signature(&self) -> Signature {

View File

@ -19,7 +19,7 @@ impl Command for ToCSV {
}
fn usage(&self) -> &str {
"Saves dataframe to csv file"
"Saves dataframe to csv file."
}
fn signature(&self) -> Signature {

View File

@ -15,7 +15,7 @@ impl Command for ToDataFrame {
}
fn usage(&self) -> &str {
"Converts a list, table or record into a dataframe"
"Converts a list, table or record into a dataframe."
}
fn signature(&self) -> Signature {

View File

@ -16,7 +16,7 @@ impl Command for ToNu {
}
fn usage(&self) -> &str {
"Converts a section of the dataframe into nushell Table"
"Converts a section of the dataframe into nushell Table."
}
fn signature(&self) -> Signature {

View File

@ -19,7 +19,7 @@ impl Command for ToParquet {
}
fn usage(&self) -> &str {
"Saves dataframe to parquet file"
"Saves dataframe to parquet file."
}
fn signature(&self) -> Signature {

View File

@ -16,7 +16,7 @@ impl Command for WithColumn {
}
fn usage(&self) -> &str {
"Adds a series to the dataframe"
"Adds a series to the dataframe."
}
fn signature(&self) -> Signature {

View File

@ -16,7 +16,7 @@ impl Command for ExprAlias {
}
fn usage(&self) -> &str {
"Creates an alias expression"
"Creates an alias expression."
}
fn signature(&self) -> Signature {

View File

@ -16,7 +16,7 @@ impl Command for ExprArgWhere {
}
fn usage(&self) -> &str {
"Creates an expression that returns the arguments where expression is true"
"Creates an expression that returns the arguments where expression is true."
}
fn signature(&self) -> Signature {

View File

@ -15,7 +15,7 @@ impl Command for ExprAsNu {
}
fn usage(&self) -> &str {
"Convert expression into a nu value for access and exploration"
"Convert expression into a nu value for access and exploration."
}
fn signature(&self) -> Signature {

View File

@ -16,7 +16,7 @@ impl Command for ExprCol {
}
fn usage(&self) -> &str {
"Creates a named column expression"
"Creates a named column expression."
}
fn signature(&self) -> Signature {

View File

@ -16,7 +16,7 @@ impl Command for ExprConcatStr {
}
fn usage(&self) -> &str {
"Creates a concat string expression"
"Creates a concat string expression."
}
fn signature(&self) -> Signature {

View File

@ -16,7 +16,7 @@ impl Command for ExprIsIn {
}
fn usage(&self) -> &str {
"Creates an is-in expression"
"Creates an is-in expression."
}
fn signature(&self) -> Signature {

View File

@ -15,7 +15,7 @@ impl Command for ExprLit {
}
fn usage(&self) -> &str {
"Creates a literal expression"
"Creates a literal expression."
}
fn signature(&self) -> Signature {

View File

@ -15,7 +15,7 @@ impl Command for ExprOtherwise {
}
fn usage(&self) -> &str {
"completes a when expression"
"completes a when expression."
}
fn signature(&self) -> Signature {

View File

@ -16,7 +16,7 @@ impl Command for ExprQuantile {
}
fn usage(&self) -> &str {
"Aggregates the columns to the selected quantile"
"Aggregates the columns to the selected quantile."
}
fn signature(&self) -> Signature {

View File

@ -16,7 +16,7 @@ impl Command for ExprWhen {
}
fn usage(&self) -> &str {
"Creates and modifies a when expression"
"Creates and modifies a when expression."
}
fn signature(&self) -> Signature {

View File

@ -17,7 +17,7 @@ impl Command for LazyAggregate {
}
fn usage(&self) -> &str {
"Performs a series of aggregations from a group-by"
"Performs a series of aggregations from a group-by."
}
fn signature(&self) -> Signature {

View File

@ -16,7 +16,7 @@ impl Command for LazyCollect {
}
fn usage(&self) -> &str {
"Collect lazy dataframe into eager dataframe"
"Collect lazy dataframe into eager dataframe."
}
fn signature(&self) -> Signature {

View File

@ -16,7 +16,7 @@ impl Command for LazyFetch {
}
fn usage(&self) -> &str {
"collects the lazyframe to the selected rows"
"collects the lazyframe to the selected rows."
}
fn signature(&self) -> Signature {

View File

@ -15,7 +15,7 @@ impl Command for LazyFillNA {
}
fn usage(&self) -> &str {
"Replaces NaN values with the given expression"
"Replaces NaN values with the given expression."
}
fn signature(&self) -> Signature {

View File

@ -15,7 +15,7 @@ impl Command for LazyFillNull {
}
fn usage(&self) -> &str {
"Replaces NULL values with the given expression"
"Replaces NULL values with the given expression."
}
fn signature(&self) -> Signature {

View File

@ -16,7 +16,7 @@ impl Command for LazyFilter {
}
fn usage(&self) -> &str {
"Filter dataframe based in expression"
"Filter dataframe based in expression."
}
fn signature(&self) -> Signature {

View File

@ -16,7 +16,7 @@ impl Command for ToLazyGroupBy {
}
fn usage(&self) -> &str {
"Creates a group-by object that can be used for other aggregations"
"Creates a group-by object that can be used for other aggregations."
}
fn signature(&self) -> Signature {

View File

@ -16,7 +16,7 @@ impl Command for LazyJoin {
}
fn usage(&self) -> &str {
"Joins a lazy frame with other lazy frame"
"Joins a lazy frame with other lazy frame."
}
fn signature(&self) -> Signature {

Some files were not shown because too many files have changed in this diff Show More