From 710349768ffb4511da73176de826e6b71140083e Mon Sep 17 00:00:00 2001 From: Antoine Stevan <44101798+amtoine@users.noreply.github.com> Date: Sat, 11 Feb 2023 14:13:40 +0100 Subject: [PATCH] remove the `--encoding` option from `register` in the examples (#8038) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # Description As `register` does not have `--encoding` as an option now, the [*Git stat plugin for Nushell*](https://github.com/nushell/nushell/tree/main/crates/nu_plugin_gstat#git-stat-plugin-for-nushell) is not correct anymore ``` > register ~/.local/share/cargo/bin/nu_plugin_gstat --encoding msgpack Error: nu::parser::unknown_flag (link) × The `register` command doesn't have flag `encoding`. ╭─[entry #22:1:1] 1 │ register ~/.local/share/cargo/bin/nu_plugin_gstat --encoding msgpack · ─────┬──── · ╰── unknown flag ╰──── help: Available flags: --help(-h), --shell(-s). Use `--help` for more information. ``` This PR then simply removes `--encoding msgpack` from the `register` call in the documentation of the `gstat` plugin. # User-Facing Changes There is no user-facing change in this PR. # Tests + Formatting This PR does not change any source code. # After Submitting Same here, nothing to report :wink: --- crates/nu_plugin_gstat/README.md | 2 +- crates/nu_plugin_inc/README.md | 2 +- crates/nu_plugin_query/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/crates/nu_plugin_gstat/README.md b/crates/nu_plugin_gstat/README.md index 997a7a21d..88db33cbf 100644 --- a/crates/nu_plugin_gstat/README.md +++ b/crates/nu_plugin_gstat/README.md @@ -10,4 +10,4 @@ To install: To register (from inside Nushell): ``` -> register --encoding msgpack \ No newline at end of file +> register diff --git a/crates/nu_plugin_inc/README.md b/crates/nu_plugin_inc/README.md index 94df73d1f..e989aba0b 100644 --- a/crates/nu_plugin_inc/README.md +++ b/crates/nu_plugin_inc/README.md @@ -10,4 +10,4 @@ cargo install --path . To register (from inside Nushell): ``` -register --encoding json +register diff --git a/crates/nu_plugin_query/README.md b/crates/nu_plugin_query/README.md index 1dbf2dc06..a3abd1808 100644 --- a/crates/nu_plugin_query/README.md +++ b/crates/nu_plugin_query/README.md @@ -10,4 +10,4 @@ To install: To register (from inside Nushell): ``` -> register --encoding json \ No newline at end of file +> register