docs

- updated CONTRIBUTING.md
- removed sample docs

.meta/docs.md

@@ -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<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.
-

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<space><space>:<space>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