Updated documentation. Added support for calling cmd2.Cmd.run_editor() with no argument.

Author: kmvanbrunt

CHANGELOG.md

@@ -53,6 +53,7 @@
     * On POSIX systems, shell commands and processes being piped to are now run in the user's preferred shell
       instead of /bin/sh. The preferred shell is obtained by reading the SHELL environment variable. If that
       doesn't exist or is empty, then /bin/sh is used.
+    * Changed `cmd2.Cmd._run_editor()` to the public method `cmd2.Cmd.run_editor()`
 
 ## 1.5.0 (January 31, 2021)
 * Bug Fixes

cmd2/cmd2.py

@@ -4634,11 +4634,11 @@ def do_edit(self, args: argparse.Namespace) -> None:
         """Run a text editor and optionally open a file with it"""
         self.run_editor(args.file_path)
 
-    def run_editor(self, file_path: Optional[str]) -> None:
+    def run_editor(self, file_path: Optional[str] = None) -> None:
         """
         Run a text editor and optionally open a file with it
 
-        :param file_path: optional path of the file to edit
+        :param file_path: optional path of the file to edit. Defaults to None.
         :raises: EnvironmentError if self.editor is not set
         """
         if not self.editor:

docs/features/redirection.rst

@@ -64,8 +64,7 @@ Disabling Redirection
        from cmd2 import Cmd
        class App(Cmd):
            def __init__(self):
-               super().__init__()
-               self.allow_redirection = False
+               super().__init__(allow_redirection=False)
 
    cmd2's parser will still treat the ``>``, ``>>``, and `|` symbols as output
    redirection and pipe symbols and will strip arguments after them from the