CLI usage text unification #1329

New issue

Open

opened 2025-12-28 17:16:03 +00:00 by sami · 2 comments

sami commented

2025-12-28 17:16:03 +00:00

Owner

Originally created by @AliceInHunterland on GitHub (Jul 9, 2024).

Sometimes we have -o file [-s start] and sometimes it --wif <wif> [--name <account_name>].
https://github.com/nspcc-dev/neo-go/pull/3495#issuecomment-2213301628

Originally created by @AliceInHunterland on GitHub (Jul 9, 2024). Sometimes we have `-o file [-s start]` and sometimes it `--wif <wif> [--name <account_name>]`. https://github.com/nspcc-dev/neo-go/pull/3495#issuecomment-2213301628

sami added the

labels

2025-12-28 17:16:03 +00:00

sami commented

2025-12-28 17:16:03 +00:00

Author

Owner

@AnnaShaleva commented on GitHub (Jul 10, 2024):

I vote for option with <> since it allows to clearly identify flag example and multi-words flags look more recognizable with <>.

@AnnaShaleva commented on GitHub (Jul 10, 2024): I vote for option with `<>` since it allows to clearly identify flag example and multi-words flags look more recognizable with `<>`.

sami commented

2025-12-28 17:16:03 +00:00

Author

Owner

@roman-khimov commented on GitHub (Jul 16, 2024):

https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html

Also

       SYNOPSIS      A brief summary of the command or function's interface.

                     For  commands, this shows the syntax of the command and its arguments (including options); boldface is used for as-is text and italics are used to indicate replaceable arguments.  Brackets ([]) surround optional arguments, vertical bars (|) separate choices, and ellipses (...) can be repeated.  For functions, it shows any required data declarations
                     or #include directives, followed by the function declaration.

@roman-khimov commented on GitHub (Jul 16, 2024): https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html Also ``` SYNOPSIS A brief summary of the command or function's interface. For commands, this shows the syntax of the command and its arguments (including options); boldface is used for as-is text and italics are used to indicate replaceable arguments. Brackets ([]) surround optional arguments, vertical bars (|) separate choices, and ellipses (...) can be repeated. For functions, it shows any required data declarations or #include directives, followed by the function declaration. ```