You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently in dune --help, the 'Common Options' section lists only two options: --help and --version. And the help pages for subcommands like dune build --help etc. also have a 'Common Options' section where they list all the other common options.
The common options should be moved from the individual subcommand help pages, into the dune --help page, and replaced with a reference to the latter page.
The text was updated successfully, but these errors were encountered:
Thanks for your comment. I can't speak for other people usages, but it seems more intuitive to have the options you can use with the command you run in the same help page than having to run --help to have access to both. Maybe I'm missing your point here?
On a side note, we are discussing internally ways to improve the Dune CLI in the future 👍
It's arguable whether the dune SUBCOMMAND --help should show the common options or just point to dune --help which should document those.
But at the very least the common options should be shown in both dune --help as well as in dune SUBCOMMAND --help. Because (and different people will have different opinions here but) some people will definitely go to dune --help to look for the common options. They won't think to look in the help manual for a specific subcommand. I know this is true because I just spoke to someone last night in the OCaml Discord who did exactly this.
As another example, we can see that the opam help pages show common options in both opam --help and in opam SUBCOMMAND --help. So we can just point to the precedent set there.
Currently in
dune --help
, the 'Common Options' section lists only two options:--help
and--version
. And the help pages for subcommands likedune build --help
etc. also have a 'Common Options' section where they list all the other common options.The common options should be moved from the individual subcommand help pages, into the
dune --help
page, and replaced with a reference to the latter page.The text was updated successfully, but these errors were encountered: