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

Bug: Incomplete usage syntax given in textclient help msg #6

Closed
ossiviljakainen opened this issue Jan 4, 2017 · 4 comments
Closed

Comments

@ossiviljakainen
Copy link

The help message of maitreya8t gives incomplete info for syntax:

Current:
Usage: maitreya8t [--help] [--help] [--date <str>] [--location <str>]

Should be updated to:
Usage: maitreya8t [--help] [--help] [--date="<str>"] [--location="<str>"]

Current:

  --date=<str>              	Set UT date YYYY-MM-DD HH:MM:SS
  --location=<str>          	Set location "name LL:LL BB:BB ZZ"

Should be updated to:

  --date=<str>              	Set UT date "YYYY-MM-DD HH:MM:SS"
  --location=<str>          	Set location "name LL:LL BB:BB (+/-)ZZ"

Also the first line appears twice:

  --help                    	show this help message
  --help                    	show this help message
martin-pe pushed a commit that referenced this issue Mar 18, 2017
@martin-pe
Copy link
Owner

Should be okay now.
Moreover plain html export and shadbala added

@ossiviljakainen
Copy link
Author

Still some required quotation marks are missing from the help text:

Current:
Usage: maitreya8t [--help] [--date <str>] [--location <str>]

Should be updated to:
Usage: maitreya8t [--help] [--date="<str>"] [--location="<str>"]

Current:
--date=<str> Set UT date YYYY-MM-DD HH:MM:SS

Should be updated to:
--date=<str> Set UT date "YYYY-MM-DD HH:MM:SS"

The file= does not require quotation marks, as one can use the unix syntax using the backslash as delimiter for space character, or alternatively encolose the filename in quotation marks.

@mack3457
Copy link

I disagree on the quotes in the usage line: a string as a parameter will always have to obey the rules of parameter strings on your particular operating system.

If you write --date=2017-01-01\ 18:57:23 on unix or --date=2017-01-0"1 "18:57:23 on windows or unix or use single quotes on unix or enclose the complete argument in quotes, doesn't make any difference.

Using --date= vs. --date etc.: yes, you are right, the normal default would be to use the equal sign on long options and no equal sign on the short form of the option if available. So, in the usage line, it should read --date= etc., even if --date can be used as well.

@ossiviljakainen
Copy link
Author

Ok thanks :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants