EliteDangerous/elite-scripts
1
0
Fork 0
Code Issues Pull requests Releases 10 Activity

regenerated docs

Browse source
This commit is contained in:
alterNERDtive 2020-01-06 17:28:40 +01:00
parent 1508ccf5c5
commit 1f113611d4
2 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -23,7 +23,7 @@ optional arguments:
## explorationtools.py ## ## explorationtools.py ##
``` ```
usage: explorationtools.py [-h] {bodycount,distancebetween,findCommander} ... usage: explorationtools.py [-h] {bodycount,distancebetween,findcommander} ...
A collection of tools useful for exploration. A collection of tools useful for exploration.
@ -31,7 +31,7 @@ optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
subcommands: subcommands:
{bodycount,distancebetween,findCommander} {bodycount,distancebetween,findcommander}
sub-command help sub-command help
bodycount Returns the number of bodies in a system. Will exit bodycount Returns the number of bodies in a system. Will exit
with code 1 on server error and code 2 if the system with code 1 on server error and code 2 if the system
@ -39,7 +39,7 @@ subcommands:
distancebetween Calculates the distance between two systems. Will exit distancebetween Calculates the distance between two systems. Will exit
with code 1 on server error and code 2 if (one of) the with code 1 on server error and code 2 if (one of) the
systems could not be found on EDSM. systems could not be found on EDSM.
findCommander Attempts to find a CMDR’s last known position. Will findcommander Attempts to find a CMDR’s last known position. Will
exit with code 1 on server error and code 2 if the exit with code 1 on server error and code 2 if the
CMDR could not be found on EDSM. CMDR could not be found on EDSM.
``` ```
@ -48,7 +48,7 @@ subcommands:
usage: explorationtools.py bodycount [-h] system usage: explorationtools.py bodycount [-h] system
positional arguments: positional arguments:
system system system to query
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
@ -58,17 +58,18 @@ optional arguments:
usage: explorationtools.py distancebetween [-h] system system usage: explorationtools.py distancebetween [-h] system system
positional arguments: positional arguments:
system system the systems to measure
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
``` ```
``` ```
usage: explorationtools.py findCommander [-h] name usage: explorationtools.py findcommander [-h] name [apikey]
positional arguments: positional arguments:
name name the commander in question
apikey the commander’s EDSM API key. Can be empty for public profiles.
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit

2
generate_docs.sh
View file

@ -32,7 +32,7 @@ cat >> README.md << EOF
\`\`\` \`\`\`
EOF EOF
./explorationtools.py findCommander -h >> README.md ./explorationtools.py findcommander -h >> README.md
cat >> README.md << EOF cat >> README.md << EOF
\`\`\` \`\`\`
EOF EOF