Rooba
/
tqdm
mirror of https://github.com/tqdm/tqdm.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

documentation 

- integrate with code
- add to readme/docs etc.
- remove file
This commit is contained in:
Nishant Rodrigues 2020-04-26 17:13:11 +05:30 committed by Casper da Costa-Luis
parent 895ee5fc2e
commit 96242d755d
No known key found for this signature in database
GPG Key ID: 986B408043AE090D
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
.meta/docs.md Normal file
View File

@ -0,0 +1,15 @@
#### Integrating new arguments with Bash autocomplete for CLI
Creating new argument
* Available through tqdm CLI
- Mention in docstring under `tqdm.tqdm.__init__.__doc__` or if *extra cli option* add to `tqdm.cli.CLI_EXTRA_DOC`
- Make sure to follow docstring formatting `argument<space><space>:<space>string`
- Add new argument to tests `tests_completion.py -> all_opts`
* Not available through tqdm CLI
- Mention in docstrings
- Add to unsupported arguments `tqdm.cli.UNSUPPORTED_OPTS`
**Note:** If new CLI available argument contains available options to select from, add the list of options for the argument under `.meta/mkcompletion.py`
**Warning:** Bash autocomplete script is generated by parsing the docstrings. Make sure the format is correct and the test pass. Currently an additional `name` argument is present that has been manually removed.