summaryrefslogtreecommitdiff
path: root/docs/features
Commit message (Collapse)AuthorAgeFilesLines
* Updated documentationmiscKevin Van Brunt2021-01-291-0/+9
|
* Merge branch 'master' into pr/docs/md/brokenlinkTodd Leonhardt2021-01-281-2/+2
|\
| * Fix doc in docs/features/commands.rstKevin "Tristate Tom" Weiss2021-01-281-2/+2
| | | | | | | | finis should be finish. A missing double quote (") for the docstring in the `do_bail` example makes formatting incorrect.
* | docs/features/modular_commands: fix broken linkKevin "Tristate Tom" Weiss2021-01-281-1/+1
|/ | | | | | | | | I guess the examples structure has changed since the docs. I suggest changing the broken link: https://github.com/python-cmd2/cmd2/tree/master/plugins/command_sets/examples to https://github.com/python-cmd2/cmd2/tree/master/examples/modular_commands Maybe also hiding the full link is nice.
* Fix wrong superclass in docKilian2021-01-021-1/+1
|
* Replace with_argparser_and_unknown_args in docsKyle King2020-11-081-11/+8
|
* Use set --verbose instead of -v in docsKyle King2020-10-311-2/+2
|
* Fixed error in set --long, which should be set -vKyle King2020-10-311-2/+2
| | | | | (Cmd) set --long Usage: set [-h] [-v] [param] [value] Error: unrecognized arguments: --long
* typoStratos Gerakakis2020-10-101-1/+1
|
* Updated documentation about set commandKevin Van Brunt2020-09-091-9/+10
|
* Fixed type hints in example code1.3.9Kevin Van Brunt2020-09-031-1/+1
|
* Documented CommandSet event handlersKevin Van Brunt2020-09-031-1/+29
|
* Updated docsKevin Van Brunt2020-09-011-4/+4
|
* Fixed issue where subcommand added with @as_subcommand_to decorator did not ↵Kevin Van Brunt2020-08-271-2/+2
| | | | | | display help when called with -h/--help. 'add_help=False' no longer has to be passed to parsers used in @as_subcommand_to decorator.
* The functions cmd2 adds to Namespaces (get_statement() and get_handler()) ↵Kevin Van Brunt2020-08-262-10/+12
| | | | | | | are now Cmd2AttributeWrapper objects named cmd2_statement and cmd2_handler. This makes it easy to filter out which attributes in an argparse.Namespace were added by cmd2.
* Updated change log and docs for release1.3.5Kevin Van Brunt2020-08-251-0/+15
|
* Fixed RecursionError when printing an argparse.Namespace caused by custom ↵Kevin Van Brunt2020-08-251-1/+2
| | | | | | attribute cmd2 was adding Added get_statement() function to argparse.Namespace which returns __statement__ attribute
* Updated documentation with more explicit discussions on testingEric Lin2020-08-202-0/+4
| | | | Added unit test to verify command name validation updates.
* Breaking change: Removed cmd2 app as a required second parameter toEric Lin2020-08-121-34/+35
| | | | | | CommandSet command functions (do_, complete_, help_). Renamed install_command_set and uninstall_command_set to register_command_set and unregister_command_set.
* Verify that a completer function is defined in a CommandSet beforeEric Lin2020-08-061-1/+2
| | | | | | | | | | 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
* Marked with_arparser_and_unknown_args deprecated and consolidatedEric Lin2020-08-041-1/+1
| | | | implementation as an option to with_argparser instead.
* Minor formatting fixes. Injecting a function into namespace objects before ↵Eric Lin2020-08-041-3/+3
| | | | passing to command handlers to access sub-command handlers
* Fix a couple doc8 warningsTodd Leonhardt2020-08-041-5/+7
|
* Suggested PR Fixes.Eric Lin2020-08-041-5/+5
| | | | | sub-commande => subcommand Added help/aliases to `as_subcommand_to` decorator.
* Adds support for injectable subcommands as part of CommandSetEric Lin2020-08-041-0/+126
| | | | | | load/unload. Updated examples and documentation to include discussion of injectable sub-commands.
* updated importsEric Lin2020-08-043-0/+214
| | | | Added additional documentation
* Fixed hook documentationKevin Van Brunt2020-07-171-9/+9
|
* Fixed command finalization exampleKevin Van Brunt2020-07-071-1/+1
|
* Move line that seemed out of place at the very end to before the "advanced" ↵Todd Leonhardt2020-06-271-3/+3
| | | | section
* Further additions to pyscript documenntation for Issue #644Eric Lin2020-06-221-0/+18
|
* Updated docsKevin Van Brunt2020-05-282-1/+20
|
* Completion doc updatesKevin Van Brunt2020-04-231-1/+2
|
* More completion doc updatesKevin Van Brunt2020-04-231-2/+2
|
* Updated tab completion documentationKevin Van Brunt2020-04-231-3/+40
|
* Documented CompletionError classKevin Van Brunt2020-04-231-0/+18
|
* Fix doc8 whitespace issueTodd Leonhardt2020-04-231-1/+1
|
* Updating documentation for table creationKevin Van Brunt2020-04-222-0/+41
|
* Fix documentation typo found in PR #915Todd Leonhardt2020-04-091-1/+1
|
* Fix extra space typoTodd Leonhardt2020-04-091-1/+1
|
* Added documentation about decorator order and updated an exampleTodd Leonhardt2020-04-091-0/+35
| | | | | Also: - Deal with warnings when building docs with Sphinx 3.0.0
* Ctrl-C now stops a running text script instead of just the current script ↵Kevin Van Brunt2020-03-262-6/+6
| | | | command
* Addressing PR feedback.kotfu2020-02-281-0/+9
|
* Merge branch 'master' into scripting_docskotfu2020-02-281-18/+24
|\
| * Revise completion docs. Fixes #800. Updates #765.kotfu2020-02-281-18/+24
| |
* | Update scripting docs. Closes #765.kotfu2020-02-282-17/+32
|/
* Remove extra newline and EOFkotfu2020-02-241-1/+0
|
* Update history documentationkotfu2020-02-241-6/+38
|
* Add argparse stuff to apikotfu2020-02-222-11/+6
|
* Revisions and improvements for hooks and pluginskotfu2020-02-223-60/+79
|
* plugin and hook documentation updateskotfu2020-02-202-75/+88
| | | | | | - add api documentation for plugin data classes - update hook and plugin documentation to link to now documented api classes