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

FoBis.py -h command #50

Closed
zmiimz opened this issue Mar 16, 2015 · 3 comments
Closed

FoBis.py -h command #50

zmiimz opened this issue Mar 16, 2015 · 3 comments

Comments

@zmiimz
Copy link

zmiimz commented Mar 16, 2015

There should be some note about additional help from
FoBiS.py build -h
FoBiS.py clean -h
FoBiS.py rule -h
commands in the FoBis.py -h output because it is not fully obvious/intuitive that they exist?

@szaghi
Copy link
Owner

szaghi commented Mar 16, 2015

Hi zmiimz,

thank you for your suggestion. Indeed, I follow the standard argparse usage, but I agree that for the end-user (with experience with Python argparse module) it is not so clear. I will try to improve the CLI help as soon as possible.

See you soon.

@szaghi
Copy link
Owner

szaghi commented Mar 17, 2015

Hi zmiimz,

I have just uploaded a new version into which (I hope) I have added a more clear help message. It should like as:

usage: FoBiS.py [-h] [-v] {rule,build,clean} ...

a Fortran Building System for poor men

optional arguments:
  -h, --help          show this help message and exit
  -v, --version       Show version

Commands:
  Valid commands

  {rule,build,clean}
    build             Build all programs found or specific target(s)
    clean             Clean project: remove all OBJs and MODs files... use
                      carefully
    rule              Execute special rules or user's ones defined into a
                      fobos file

For more detailed commands help use
  FoBiS.py build -h,--help
  FoBiS.py clean -h,--help
  FoBiS.py rule -h,--help

Does it look more clear now?

I have also added you into the contributors list: https://github.com/szaghi/FoBiS/wiki/About#contributors

I am closing this issue, but if you do not like the new help message reopen the issue and let me know how to improve it.

Thank you for using FoBiS.py.

See you soon.

@szaghi szaghi closed this as completed Mar 17, 2015
@zmiimz
Copy link
Author

zmiimz commented Mar 17, 2015

yes, indeed.
thank you.

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

2 participants