summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
...
| * | | | | | | | | | Merge branch 'master' into pr/doc/commandsTodd Leonhardt2021-01-281-3/+6
| |\ \ \ \ \ \ \ \ \ \
| | * | | | | | | | | | Update conditional pyreadline3 dependency for WinKyle King2021-01-271-3/+6
| | | |_|_|_|_|_|_|_|/ | | |/| | | | | | | |
| * | | | | | | | | | 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
| | | | | | | |
* | | | | | | | Fixed issue where quoted redirectors and terminators in aliases and macros ↵Kevin Van Brunt2020-09-301-0/+4
| |_|_|_|_|_|/ |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | were not being restored when read from a startup script.
* | | | | | | 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-263-11/+13
| |_|/ |/| | | | | | | | | | | | | | | | | 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-207-8/+80
|/ | | | 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-062-1/+5
| | | | | | | | | | 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
* Fixes to sphinx generationEric Lin2020-08-042-0/+6
|
* Fixed hook documentationKevin Van Brunt2020-07-171-9/+9
|
* Address fact that typing.Deque wasn't defined prior to 3.5.4Todd Leonhardt2020-07-131-0/+1
|
* replace pkg_resources with importlib.metadataDoug Hellmann2020-07-121-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | Importing pkg_resources has a side-effect of scanning every installed distribution on sys.path to load the metadata, especially the entry points defined in the packages. This can have a significant launch-time cost for command line applications when there are a lot of distributions to scan. Since cmd2 is only using pkg_resources to find the version of the installed package, pkg_resources can be replaced with importlib.metadata. The implementation in the new library is significantly faster because it goes immediately to the metadata file for the requested distribution, instead of scanning all of them. There are also no import-time side-effects. importlib.metadata is a new standard library module starting with python 3.8. For earlier versions, a compatible library has been released to PyPI as 'importlib_metadata'. This change adds the new dependency with a qualifier so that it is only applied to older versions of python, and then updates the places that were importing pkg_resources to look for the different versions of the new library instead. The documentation configuration is changed to import cmd2 itself to get its version, since the package has to be installed for the metadata to be available anyway. Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* 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-224-0/+114
|
* Updated docsKevin Van Brunt2020-05-282-1/+20
|
* Added SkipPostcommandHooks exception and made Cmd2ArgparseError inherit from it.Kevin Van Brunt2020-05-072-13/+26
| | | | Both exception classes have been added to the public API.
* Added info on semantic versioning and branching strategy to CONTRIBUTING.mdTodd Leonhardt2020-04-241-2/+1
| | | | | | | Also: - Added isort to Pipenv dev - Added setup.cfg to make it easy to run flake8, doc8, and isort directly from the command line without using invoke - Ran isort to sort includes
* 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-223-0/+42
|
* Updated docsKevin Van Brunt2020-04-223-0/+37
|
* 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-092-0/+48
| | | | | Also: - Deal with warnings when building docs with Sphinx 3.0.0
* The continuation_prompt attribute was declared twice in cmd.rst - this fixes ↵Todd Leonhardt2020-04-081-5/+1
| | | | and consolidates that
* 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
|
View Lorry Controller Status