search

oracle / oci-python-sdk

Oracle Cloud Infrastructure SDK for Python
https://cloud.oracle.com/cloud-infrastructure
Other
383 stars 275 forks source link

a little typo in the documentation how to run CLI with help option $ python3 oci_capacity_reporter_gui.py -help #659

Open AlexBGoode opened 2 months ago

AlexBGoode commented 2 months ago

hello folks just my observation that the proposed way to call for help (with single dash):

python3 oci_capacity_reporter_gui.py -help

does not work as expected and causes an error:

> python oci_capacity_reporter_gui.py -help
oci_capacity_reporter_gui.py: error: argument -h/--help: ignored explicit argument 'elp'

meanwhile the way how it usualy done in Linux (double -) is okay:

> python oci_capacity_reporter_gui.py --help
options:
   -h, --help         show this help message and exit
   -c CONFIG_FILE     OCI CLI Config file
   -t CONFIG_PROFILE  Config Profile inside the config file
   -p PROXY           Set Proxy (i.e. www-proxy-server.com:80)
   -ip                Use Instance Principals for Authentication
   -is                Use Config and Security Token

the affected doc page is the following: https://github.com/oracle/oci-python-sdk/tree/master/examples/oci_capacity_reporter

adizohar commented 2 months ago

Thank you Alex

I will push an update to the documentation for --help.