Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AlexBGoode opened this issue Jun 15, 2024 · 1 comment

Comments

@AlexBGoode
Copy link

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
Copy link
Member

Thank you Alex

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants