search

aspnet / dnvm

OBSOLETE - see readme
Other
174 stars 61 forks source link

dnvm usage help does not conform to unix docs convention #479

Closed colhountech closed 6 years ago

colhountech commented 9 years ago

dnvm Usage output does not conform to cross platform docs convensions (i.e. unix docs. 

usage:
dnvm install [<VersionNuPkgOrAlias>] [-a <Architecture>] [-r <Runtime>] [-OS <OS>] [-Alias <Alias>] [-f] [-Proxy <Proxy>] [-NoNative] [-Ng
en] [-p] [-u] [-g]

There is a unix convention that states that optional parameters are surrounded with [] so based on the description above everything after the dnvm install should be optional.

Since dnx/dnvm/aspnet is now cross platform it would be valuable to adhere to the standard convetions that is use by unix man pages

In the SYNOPSIS section. "Brackets ([]) surround optional arguments". 

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.