summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEric Lin <anselor@gmail.com>2020-08-05 15:08:37 -0400
committeranselor <anselor@gmail.com>2020-08-06 16:01:19 -0400
commit62eccdac73d852d3ab9df06497bc8c9063e3d283 (patch)
tree2c7a02a8589270447d9ef611f0f6f170e5f0528f /docs
parent2c99c0d9e7ddea1a93e97e3198aea01beca7c5d5 (diff)
downloadcmd2-git-62eccdac73d852d3ab9df06497bc8c9063e3d283.tar.gz
Verify that a completer function is defined in a CommandSet before
passing it a CommandSet instance. Search for a CommandSet instance that matches the completer's parent class type.` Resolves Issue #967 Renamed isolated_tests directory to tests_isolated for better visual grouping. Added some exception documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/api/exceptions.rst3
-rw-r--r--docs/features/modular_commands.rst3
2 files changed, 5 insertions, 1 deletions
diff --git a/docs/api/exceptions.rst b/docs/api/exceptions.rst
index 8ef0a61f..db23eb0a 100644
--- a/docs/api/exceptions.rst
+++ b/docs/api/exceptions.rst
@@ -9,3 +9,6 @@ Custom cmd2 exceptions
.. autoclass:: cmd2.exceptions.Cmd2ArgparseError
:members:
+
+.. autoclass:: cmd2.exceptions.CommandSetRegistrationError
+ :members:
diff --git a/docs/features/modular_commands.rst b/docs/features/modular_commands.rst
index 9823d3ac..d19c3b45 100644
--- a/docs/features/modular_commands.rst
+++ b/docs/features/modular_commands.rst
@@ -8,7 +8,8 @@ Cmd2 also enables developers to modularize their command definitions into Comman
a logical grouping of commands within an cmd2 application. By default, all CommandSets will be discovered and loaded
automatically when the cmd2.Cmd class is instantiated with this mixin. This also enables the developer to
dynamically add/remove commands from the cmd2 application. This could be useful for loadable plugins that
-add additional capabilities.
+add additional capabilities. Additionally, it allows for object-oriented encapsulation and garbage collection of state
+that is specific to a CommandSet.
Features
~~~~~~~~