summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorEric Lin <anselor@gmail.com>2020-08-20 13:35:47 -0400
committerEric Lin <anselor@gmail.com>2020-08-20 18:08:45 -0400
commitc62293103e97fd36a4f344d5d6c4c59a2c5b3e59 (patch)
tree095f9a241a1ca5d523d0fd993704b682385d1a33 /docs/api
parent9a20e7ca66bdab4581409d1eac16c931db08d6b6 (diff)
downloadcmd2-git-c62293103e97fd36a4f344d5d6c4c59a2c5b3e59.tar.gz
Updated documentation with more explicit discussions on testing
Added unit test to verify command name validation updates.
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/index.rst2
-rw-r--r--docs/api/plugin_external_test.rst9
2 files changed, 11 insertions, 0 deletions
diff --git a/docs/api/index.rst b/docs/api/index.rst
index 17a25907..1a49adfa 100644
--- a/docs/api/index.rst
+++ b/docs/api/index.rst
@@ -32,6 +32,7 @@ This documentation is for ``cmd2`` version |version|.
py_bridge
table_creator
utils
+ plugin_external_test
**Modules**
@@ -56,3 +57,4 @@ This documentation is for ``cmd2`` version |version|.
embedded python environment to the host app
- :ref:`api/table_creator:cmd2.table_creator` - table creation module
- :ref:`api/utils:cmd2.utils` - various utility classes and functions
+- :ref:`api/plugin_external_test:cmd2_ext_test` - External test plugin
diff --git a/docs/api/plugin_external_test.rst b/docs/api/plugin_external_test.rst
new file mode 100644
index 00000000..58450b11
--- /dev/null
+++ b/docs/api/plugin_external_test.rst
@@ -0,0 +1,9 @@
+cmd2_ext_test
+=============
+
+External Test Plugin
+
+
+.. autoclass:: cmd2_ext_test.ExternalTestMixin
+ :members:
+