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

EXIT STATUS section, mention the full command rather than only the sub command. #168

Closed
Alizter opened this issue Dec 3, 2022 · 7 comments · Fixed by ocaml-dune/cmdliner#3

Comments

@Alizter
Copy link

Alizter commented Dec 3, 2022

When printing the doc for the exit code statuses the following is used:

`P "$(tname) exits with the following status:"
31

There are two issues here:

  1. status should be statuses since there is more than one exit code in most cases.
  2. The full command name is not printed, but rather the subcommand. For instance
  EXIT STATUS
         rpc exits with the following status:

should rather be

  EXIT STATUS
         dune rpc exits with the following status:
@dbuenzli
Copy link
Owner

dbuenzli commented Dec 3, 2022

  1. status should be statuses since there is more than one exit code in most cases.

I disagree, using statuses would convey that it is possible to exit with more than one status. You should read the preamble sentence and each case as a declaration.

@dbuenzli dbuenzli changed the title Typo in exit code entry for man EXIT STATUS section, mention the full command rather than only the sub command. Dec 3, 2022
@Alizter
Copy link
Author

Alizter commented Dec 4, 2022

Then perhaps it should be:

         rpc exits with one of the following statuses:

@dbuenzli
Copy link
Owner

dbuenzli commented Dec 4, 2022

But then you need to deal with singular and plural.

@Alizter
Copy link
Author

Alizter commented Dec 4, 2022

Is it likely that it is ever singular however? That seems to be an edge case here.

@dbuenzli
Copy link
Owner

dbuenzli commented Dec 4, 2022

Well you won't be the person who gets an issue the day a user of the library falls on the case and decides to report it…

dbuenzli added a commit that referenced this issue Apr 9, 2023
It has the whole command invocation closes #168.
@dbuenzli
Copy link
Owner

dbuenzli commented Apr 9, 2023

Regarding 1. I simplified the default EXIT STATUS wording to $(iname) exits with: which works with both singular and plural.

@Alizter
Copy link
Author

Alizter commented Apr 9, 2023

Thanks!

emillon pushed a commit to ocaml-dune/cmdliner that referenced this issue Sep 25, 2023
emillon pushed a commit to ocaml-dune/cmdliner that referenced this issue Sep 25, 2023
It has the whole command invocation closes dbuenzli#168.
emillon pushed a commit to ocaml-dune/cmdliner that referenced this issue Sep 25, 2023
emillon pushed a commit to ocaml-dune/cmdliner that referenced this issue Sep 25, 2023
It has the whole command invocation closes dbuenzli#168.

Signed-off-by: Etienne Millon <[email protected]>
dbuenzli added a commit that referenced this issue Nov 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants