oracle / oracle/oci-python-sdk
a little typo in the documentation how to run CLI with help option $ python3 oci_capacity_reporter_gui.py -help
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 474
- Forks
- 321
- Avg merge
- 23m
- Merged PRs (30d)
- 4
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the affected documentation in the examples/oci_capacity_reporter page and locate the command showing the help option. Change the documented single-dash form to the working double-dash form, then verify it matches the displayed --help output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 42/100