mirror of
https://github.com/aljazceru/python-teos.git
synced 2025-12-17 06:04:21 +01:00
Fixes docs and adds register help
This commit is contained in:
20
cli/help.py
20
cli/help.py
@@ -3,6 +3,7 @@ def show_usage():
|
||||
"USAGE: "
|
||||
"\n\tpython teos_cli.py [global options] command [command options] [arguments]"
|
||||
"\n\nCOMMANDS:"
|
||||
"\n\tregister \tRegisters your user public key with the tower."
|
||||
"\n\tadd_appointment \tRegisters a json formatted appointment with the tower."
|
||||
"\n\tget_appointment \tGets json formatted data about an appointment from the tower."
|
||||
"\n\thelp \t\t\tShows a list of commands or help for a specific command."
|
||||
@@ -14,12 +15,23 @@ def show_usage():
|
||||
)
|
||||
|
||||
|
||||
def help_register():
|
||||
return (
|
||||
"NAME:"
|
||||
"\n\n\tregister"
|
||||
"\n\nUSAGE:"
|
||||
"\n\n\tpython teos_cli.py register"
|
||||
"\n\nDESCRIPTION:"
|
||||
"\n\n\tRegisters your user public key with the tower."
|
||||
)
|
||||
|
||||
|
||||
def help_add_appointment():
|
||||
return (
|
||||
"NAME:"
|
||||
"\tpython teos_cli add_appointment - Registers a json formatted appointment to the tower."
|
||||
"\n\tadd_appointment - Registers a json formatted appointment to the tower."
|
||||
"\n\nUSAGE:"
|
||||
"\tpython teos_cli add_appointment [command options] appointment/path_to_appointment_file"
|
||||
"\n\tpython teos_cli.py add_appointment [command options] appointment/path_to_appointment_file"
|
||||
"\n\nDESCRIPTION:"
|
||||
"\n\n\tRegisters a json formatted appointment to the tower."
|
||||
"\n\tif -f, --file *is* specified, then the command expects a path to a json file instead of a json encoded "
|
||||
@@ -33,9 +45,9 @@ def help_add_appointment():
|
||||
def help_get_appointment():
|
||||
return (
|
||||
"NAME:"
|
||||
"\tpython teos_cli get_appointment - Gets json formatted data about an appointment from the tower."
|
||||
"\n\tget_appointment - Gets json formatted data about an appointment from the tower."
|
||||
"\n\nUSAGE:"
|
||||
"\tpython teos_cli get_appointment appointment_locator"
|
||||
"\n\tpython teos_cli.py get_appointment appointment_locator"
|
||||
"\n\nDESCRIPTION:"
|
||||
"\n\n\tGets json formatted data about an appointment from the tower.\n"
|
||||
)
|
||||
|
||||
Reference in New Issue
Block a user