From 96242d755d2e3f758cfa70db5c3f5845cb332028 Mon Sep 17 00:00:00 2001 From: Nishant Rodrigues Date: Sun, 26 Apr 2020 17:13:11 +0530 Subject: [PATCH] documentation - integrate with code - add to readme/docs etc. - remove file --- .meta/docs.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .meta/docs.md diff --git a/.meta/docs.md b/.meta/docs.md new file mode 100644 index 00000000..3ab64c0a --- /dev/null +++ b/.meta/docs.md @@ -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: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. +