diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/features/commands.rst | 4 | ||||
| -rw-r--r-- | docs/features/modular_commands.rst | 2 | ||||
| -rw-r--r-- | docs/overview/integrating.rst | 9 |
3 files changed, 9 insertions, 6 deletions
diff --git a/docs/features/commands.rst b/docs/features/commands.rst index 8e61a472..cc603f70 100644 --- a/docs/features/commands.rst +++ b/docs/features/commands.rst @@ -127,7 +127,7 @@ without errors), and that ``cmd2`` should prompt the user for more input. If you return ``True`` from a command method, that indicates to ``cmd2`` that it should stop prompting for user input and cleanly exit. ``cmd2`` already includes a ``quit`` command, but if you wanted to make another one called -``finis`` you could:: +``finish`` you could:: def do_finish(self, line): """Exit the application""" @@ -156,7 +156,7 @@ system shell:: """A simple cmd2 application.""" def do_bail(self, line): - """Exit the application"" + """Exit the application""" self.perror("fatal error, exiting") self.exit_code = 2 return true diff --git a/docs/features/modular_commands.rst b/docs/features/modular_commands.rst index 790b933e..8bd9ba2f 100644 --- a/docs/features/modular_commands.rst +++ b/docs/features/modular_commands.rst @@ -29,7 +29,7 @@ Features See API documentation for :attr:`cmd2.command_definition.CommandSet` -See the examples for more details: https://github.com/python-cmd2/cmd2/tree/master/plugins/command_sets/examples +See [the examples](https://github.com/python-cmd2/cmd2/tree/master/examples/modular_commands) for more details. Defining Commands diff --git a/docs/overview/integrating.rst b/docs/overview/integrating.rst index db5cb206..041083bc 100644 --- a/docs/overview/integrating.rst +++ b/docs/overview/integrating.rst @@ -26,10 +26,13 @@ Windows Considerations If you would like to use :ref:`features/completion:Completion`, and you want your application to run on Windows, you will need to ensure you install the -``pyreadline`` package. Make sure to include the following in your -``setup.py``:: +``pyreadline3`` or ``pyreadline`` package. Make sure to include the following +in your ``setup.py``:: install_requires=[ 'cmd2>=1,<2', - ":sys_platform=='win32'": ['pyreadline'], + ":sys_platform=='win32'": [ + "pyreadline ; python_version<'3.8'", + "pyreadline3 ; python_version>='3.8'", # pyreadline3 is a drop-in replacement for Python 3.8 and above + ], ] |