Closed pcw24601 closed 1 year ago
further information on docopt (and the alternative, argparse) for future reference: https://stackoverflow.com/questions/20599513/python-difference-between-docopt-and-argparse https://realpython.com/comparing-python-command-line-parsing-libraries-argparse-docopt-click/
The CLI interface description in the docstring in
./hazenlib/__init.py__
does not conform to thedocopt
specification. Thearguments
dict returned bydocopt(__doc__)
contains keys for the tasks (which are not used), in addition to having the task stored under the<task>
key. Furthermore, it contains anOptions:
key.The
__doc__
string should be re-written to follow thedocopt
specifications (see examples and more examples). Including better usage cases would be ideal, especially for options which only apply to one task.Example: Calling
hazen relaxometry my/path
creates the followingarguments
dict:All entries below
<task>
should not be present.