From 5054094ca5a3569a435dcfbba0757ee93c49ba90 Mon Sep 17 00:00:00 2001
From: Yael-II <154762804+Yael-II@users.noreply.github.com>
Date: Thu, 28 Nov 2024 23:04:49 +0100
Subject: [PATCH] updated the help and README

---
 README.md                    | 30 ++++++++++++++++++------------
 Source/astrobs_v1_toolbox.py | 14 +++++++++++---
 2 files changed, 29 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 94af086..c8208cf 100644
--- a/README.md
+++ b/README.md
@@ -44,22 +44,28 @@ First, select a configuration file (if none, default is selected).
 Then, select the action you wish to perform. 
 
 Available commands (not case sensitive):
-- help, h, ?: show this page
-- quit, exit, q: quit the current code
-- cancel, back: cancels the current action
-- write, save: write the current table in a file 
+- `help`, `h`, `?`: show this page
+- `quit`, `exit`, `q`: quit the current code 
+(WARNING: this does not save the current state!)
+- `write`, `save`: write the current table in a file 
 (no options available yet)
-- read, open [filename]: loads the file "filename" 
+- `read [filename]`, `open [filename]`: loads the file "filename" 
 in the current table (no additional options available yet)
-- calibration, calib: adds a calibration in the target list
-- simbad [object name], object [object name]: 
+- `calibration`, `calib`: adds a calibration in the target list
+- `simbad [object name]`, `object [object name]`: 
 add an object from simbad
-- search [ra] [dec] [radius], region [ra] [dec] [radius]: 
+- `search [ra] [dec] [radius]`, `region [ra] [dec] [radius]`: 
 search a region centred on the ra/dec coordinates, 
 with a given radius (coordinates should be expressed as 
-12h30m30s, 90d30m30s or 90.555d)
-- sidereal, st: computes the sidereal time for each target
-- sequence, seq: computes the sequence order for each 
+`12h30m30s`, `90d30m30s` or `90.555d`)
+- `sidereal`, `st`: computes the sidereal time for each target
+- `sequence`, `seq`: computes the sequence order for each 
 target
-- check: check if all targets are in the observation field
+- `check`: check if all targets are in the observation field
 
+General actions:
+- `cancel`, `back`: cancels the current action
+- `yes`, `y`, `1`: yes
+- `no`, `n`, `0`, or anything else: no
+- `all`, `*`: select all
+- `done`, `ok`: confirm, save the current state and quit
diff --git a/Source/astrobs_v1_toolbox.py b/Source/astrobs_v1_toolbox.py
index 315ecee..ed71f23 100644
--- a/Source/astrobs_v1_toolbox.py
+++ b/Source/astrobs_v1_toolbox.py
@@ -707,11 +707,12 @@ def print_help():
              "Help will be always given to those who ask for it [1].\n"
              "Available commands (not case sensitive):\n"
              "\t- help, h, ?: show this page\n"
-             "\t- quit, exit, q: quit the current code\n"
-             "\t- cancel, back: cancels the current action\n"
+             "\t- quit, exit, q: quit the current code "
+             "(WARNING: this does not save the current state!)\n"
              "\t- write, save: write the current table in a file "
              "(no options available yet)\n"
-             "\t- read, open [filename]: loads the file \"filename\" "
+             "\t- read [filename], open [filename]: "
+             "loads the file \"filename\" "
              "in the current table (no additional options available yet)\n"
              "\t- calibration, calib: adds a calibration in the target list\n"
              "\t- simbad [object name], object [object name]: "
@@ -725,6 +726,13 @@ def print_help():
              "target\n"
              "\t- check: check if all targets are in the observation field\n"
              "\n"
+             "General actions: \n"
+             "\t- cancel, back: cancels the current action\n"
+             "\t- yes, y, 1: yes\n"
+             "\t- no, n, 0, or anything else: no\n"
+             "\t- all, *: select all\n"
+             "\t- done, ok: confirm, save the current state and quit"
+             "\n"
              "[1] Pr. Dumbledore, Albus Percival Wulfric Brian, 1992, Hogwarts School of Witchcraft and Wizardry"
              "\033[0m")
     print(hilfe)