cloudmesh / cloudmesh-queue

Other
0 stars 0 forks source link

fix manual page in code and markdonwn file #7

Closed laszewsk closed 3 years ago

laszewsk commented 3 years ago
laszewsk commented 3 years ago

looks like this is the next tasks before it gets more complex ;-)

laszewsk commented 3 years ago

can you work on the script.

laszewsk commented 3 years ago

and then naturally focus on making sure the manual is up to date ;-)

laszewsk commented 3 years ago

./bin/make-update.py is done it is calleble via make readme

laszewsk commented 3 years ago

updated your tasks. we are almost done with cloudmesh-job documentation ;-)

kpimparkar commented 3 years ago

Required corrections are done. README.md is regenerated using make to sync manual page between job.py and README.md

laszewsk commented 3 years ago

I improved. Job.py while keeping your previous defaults but removing some of the Ex. instead. I think its now fitting and we can leverage the defaults from docopts. Could you check quickly

Do we actually have a unit check for this? we do not have to check everything ...

but maybe something like

cms set host=huliet cms job --.....

laszewsk commented 3 years ago

I have improved the test by removing your hardcoded username with cms set variables. I also updated the usage on top. I think it would be good to add a section Tests and just put the 4 lines on how to check the test. The tee in the documentation is not needed.

kpimparkar commented 3 years ago

The tasks mentioned in this issue are complete.