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

--version, suggest --help instead of dumping entire usage #891

Closed
kberry opened this issue Feb 8, 2016 · 2 comments
Closed

--version, suggest --help instead of dumping entire usage #891

kberry opened this issue Feb 8, 2016 · 2 comments
Assignees
Milestone

Comments

@kberry
Copy link

kberry commented Feb 8, 2016

it would be nice if gregorio supported the widespread --version option along with --help. Here is some info for it:
https://www.gnu.org/prep/standards/html_node/_002d_002dversion.html

Also, it would be nice if gregorio, when invoked with no arguments, just said something like:
gregorio: missing file operand
Try 'gregorio --help' for more information.
instead of dumping the whole usage message.

Similarly, when there is an error in arg parsing, an invocation like "gregorio -o" with no argument, it's nicer to just report the error and give the suggestion instead of dumping the whole usage message. That is usually too much info.

Also, the spaces before colons ("Usage :", "is :"), while I know are usual in French, are just weirdly wrong in English. There's also no need for the newline before "Usage", or the newline after the "Usage:", or an extra newline at the end. Fewer lines is better.

Also, it is highly useful to write a sentence or two about what the program does in the --help message. Something like "Engrave Gregorian chant scores: convert a gabc file to GregorioTeX."

Also, it's typical to capitalize metavariables like "FORMAT" and "FILE" in the help message.

Also, the help message could/should end with a url to the overall project home page.

Also, it is not usual to capitalize "Chant" in "Gregorian chant", as far as I've seen.

See pretty much any GNU --help (and --version) message for examples of all this in action. "mv --help" is reasonably short and instructive.

Happy helping.

@eroux eroux added this to the 4.1 milestone Feb 8, 2016
@eroux
Copy link
Contributor

eroux commented Feb 8, 2016

Thanks a lot, we'll take care of that in rc1 which should be out next Sunday (beta2 has been released a few minutes ago!)

@eroux eroux self-assigned this Feb 9, 2016
eroux added a commit that referenced this issue Feb 9, 2016
eroux added a commit that referenced this issue Feb 9, 2016
@eroux
Copy link
Contributor

eroux commented Feb 9, 2016

Closed by #892

@eroux eroux closed this as completed Feb 9, 2016
rpspringuel added a commit to rpspringuel/gregorio that referenced this issue Feb 9, 2016
…miktex

* commit '1344625ef8f6222f67ac1b3068e91153531cc83e': (23 commits)
  more messages to stderr, add message for non-fatal error cases
  print usage in print_short_usage
  document
  fix doc pdf file names
  improve code (no output change)
  oops
  address more comments
  fix @henryso's notes, more coherent case
  first attempt to fix gregorio-project#891
  Rewording for clarity
  Update Version number for new beta
  final optimization (no test change)
  Restored the #define for va_start/va_arg/va_end.
  Eliminated problems found by clang static analysis. For gregorio-project#697.
  document
  withmora -> morawidth
  more TeX perf optimizations
  TeX performance optimization
  first working attempt (doesn't work on different syllables)
  Applied attributes to support functions.
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants