Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLI usage text unification #3507

Open
AliceInHunterland opened this issue Jul 9, 2024 · 2 comments
Open

CLI usage text unification #3507

AliceInHunterland opened this issue Jul 9, 2024 · 2 comments
Labels
cli Command line interface documentation Improvements or additions to documentation enhancement Improving existing functionality good first issue Good for newcomers I3 Minimal impact S4 Routine U4 Nothing urgent
Milestone

Comments

@AliceInHunterland
Copy link
Contributor

AliceInHunterland commented Jul 9, 2024

Sometimes we have -o file [-s start] and sometimes it --wif <wif> [--name <account_name>].
#3495 (comment)

@AliceInHunterland AliceInHunterland added I3 Minimal impact documentation Improvements or additions to documentation U4 Nothing urgent enhancement Improving existing functionality cli Command line interface S4 Routine labels Jul 9, 2024
@AnnaShaleva AnnaShaleva changed the title cli usage text unification CLI usage text unification Jul 10, 2024
@AnnaShaleva
Copy link
Member

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

@AnnaShaleva AnnaShaleva added this to the v0.106.3 milestone Jul 10, 2024
@roman-khimov roman-khimov added the good first issue Good for newcomers label Jul 16, 2024
@roman-khimov
Copy link
Member

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 roman-khimov modified the milestones: v0.106.3, v0.106.4 Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Command line interface documentation Improvements or additions to documentation enhancement Improving existing functionality good first issue Good for newcomers I3 Minimal impact S4 Routine U4 Nothing urgent
Projects
None yet
Development

No branches or pull requests

3 participants