From cb2feea2ef0a59d3cea030fde9d89e3f0cb917bb Mon Sep 17 00:00:00 2001 From: Nishant Rodrigues Date: Sun, 26 Apr 2020 23:32:36 +0530 Subject: [PATCH] docs - updated CONTRIBUTING.md - removed sample docs --- .meta/docs.md | 15 --------------- CONTRIBUTING.md | 13 +++++++++++++ 2 files changed, 13 insertions(+), 15 deletions(-) delete mode 100644 .meta/docs.md diff --git a/.meta/docs.md b/.meta/docs.md deleted file mode 100644 index 3ab64c0a..00000000 --- a/.meta/docs.md +++ /dev/null @@ -1,15 +0,0 @@ -#### 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: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. - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9531457e..ea38a3a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,6 +62,19 @@ However it would be helpful to bear in mind: * beta: well-used; commented, perhaps still missing tests * stable: >10 users; commented, 80% coverage +#### Integrating new arguments with Bash autocomplete for CLI + +Creating new argument +- Supported by tqdm CLI + + Update docstring under `tqdm.tqdm.__init__.__doc__` or if *extra cli option* add to `tqdm.cli.CLI_EXTRA_DOC` + + Follow docstring formatting `argument:string` +- Not supported by tqdm CLI + + Update docstrings under `tqdm.tqdm.__init__.__doc__` + + Add unsupported argument to `tqdm.cli.UNSUPPORTED_OPTS` + +**Note:** Options for CLI arguments added to script `.meta/mkcompletion.py` + +**Warning:** An additional `name` argument is ignored. ## TESTING