From 421c1b4973190eaa82cb3955171641ce11a81dd8 Mon Sep 17 00:00:00 2001 From: Sergi Delgado Segura Date: Thu, 11 Jul 2019 16:56:00 +0200 Subject: [PATCH] Updates README and fixes typos --- pisa-btc/apps/cli/README.md | 6 ++---- pisa-btc/apps/cli/help.py | 2 +- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/pisa-btc/apps/cli/README.md b/pisa-btc/apps/cli/README.md index ffc0139..f3fe2aa 100644 --- a/pisa-btc/apps/cli/README.md +++ b/pisa-btc/apps/cli/README.md @@ -56,14 +56,12 @@ The API will return a `text/plain` HTTP response code `200/OK` if the appointmen python pisa-cli add_appointment [command options] / -if `-f, --file` **is** specified, the the command expects a path to a json file instead of a json encoded +if `-f, --file` **is** specified, then the command expects a path to a json file instead of a json encoded string as parameter. #### Options - `-f, --file path_to_json_file` loads the appointment data from the specified json file instead of command line. -An example of a json encoded appointment file can be found in `example_appointment_data.json` - #### Example The easier way to generate an appointment is using the testing command `generate_dummy_appointment`. @@ -78,7 +76,7 @@ To send the appointment to the PISA server run: `python pisa-cli.py add_appointment -f dummy_appointment_data.json ` -**Notice that this appointment will never be fulfilled (it will eventually expire) since it does not , but will give you an easy wat to interact with the API.** +**Notice that this appointment will never be fulfilled (it will eventually expire) since it does not corresopond to a valid transaction, but will give you an easy wat to interact with the API.** ### get_appointment diff --git a/pisa-btc/apps/cli/help.py b/pisa-btc/apps/cli/help.py index d39020e..71d3e82 100644 --- a/pisa-btc/apps/cli/help.py +++ b/pisa-btc/apps/cli/help.py @@ -5,7 +5,7 @@ def help_add_appointment(): "\tpython pisa-cli add_appointment [command options] appointment/path_to_appointment_file" \ "\n\nDESCRIPTION:" \ "\n\n\tRegisters a json formatted appointment to the PISA server." \ - "\n\tif -f, --file *is* specified, the the command expects a path to a json file instead of a json encoded " \ + "\n\tif -f, --file *is* specified, then the command expects a path to a json file instead of a json encoded " \ "\n\tstring as parameter." \ "\n\nOPTIONS:" \ "\n\t -f, --file path_to_json_file\t loads the appointment data from the specified json file instead of" \