neo-go icon indicating copy to clipboard operation
neo-go copied to clipboard

CLI usage text unification

Open AliceInHunterland opened this issue 1 year ago • 2 comments

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

AliceInHunterland avatar Jul 09 '24 16:07 AliceInHunterland

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

AnnaShaleva avatar Jul 10 '24 15:07 AnnaShaleva

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 avatar Jul 16 '24 09:07 roman-khimov