-
Notifications
You must be signed in to change notification settings - Fork 10
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
CLI documentation is low information and has jargon #208
Comments
This low-information and jargon-filled documentation is common with the other CLI commands. Here's some cases I found: $ # output trimmed to show command description
$ htmap clean --help
Clean up maps.
$ htmap hold --help
Hold maps.
$ htmap pause --help
Pause maps
$ htmap reasons --help
Print the hold reasons for maps.
$ htmap release --help
Release maps.
$ htmap rerun --help
Rerun (part of) a map.
$ htmap resume --help
Resume maps.
$ htmap retag --help
Retag a map.
$ htmap tags --help
Print tags. In most of these examples, |
Very good point! |
How do I completely clean my submit node? I want to immediately stop all jobs and start completely fresh. Currently, I'm doing this: htmap vacate --all
htmap release --all
htmap pause --all
htmap remove --all
htmap clean --all
|
|
Is your feature request related to a problem? Please describe.
I'd like to stop all my submitted jobs and re-submit. I'm having some difficulty figuring out which command line option does that. Various options are:
$ htmap clean --help Usage: htmap clean [OPTIONS] Clean up maps. Options: --all Remove non-transient maps as well. $ htmap release Usage: htmap release [OPTIONS] [TAGS]... Release maps. # ...
I find this documentation to be very low-information and not very clear. The
--help
flag doesn't add much information: in these two examples, the--help
flag really only adds the word "map".Additionally, what exactly does "release" and "clean" mean? I'm not familiar with HTCondor's jargon; to me, "release" and "clean" could both mean "remove all existing tags".
Describe the solution you'd like
Some better documentation, describing the output the command has without using any HTCondor jargon. These two pieces of documentation are good examples:
To me, this is more clear. It clearly describes the output of the command without using any HTCondor jargon. I can clearly see that
htmap logs
will print a path to a logs file.However,
htmap vacate
could still use some improvement; it still has some jargon. What happens after the resources are freed? Do the maps claim new resources?The text was updated successfully, but these errors were encountered: