From c3dcfaa3a9245cfa027af0b1a3a3e8988582b83c 2024-04-16 15:44:59 From: M Bussonnier Date: 2024-04-16 15:44:59 Subject: [PATCH] DOCS: update simple_prompt phrasing. (#14404) Closes #14402 --- diff --git a/IPython/terminal/interactiveshell.py b/IPython/terminal/interactiveshell.py index 4b930e4..1e53b39 100644 --- a/IPython/terminal/interactiveshell.py +++ b/IPython/terminal/interactiveshell.py @@ -225,11 +225,14 @@ class TerminalInteractiveShell(InteractiveShell): help="""Use `raw_input` for the REPL, without completion and prompt colors. Useful when controlling IPython as a subprocess, and piping STDIN/OUT/ERR. Known usage are: - IPython own testing machinery, and emacs inferior-shell integration through elpy. + IPython own testing machinery, and emacs inferior-python integration through elpy. This mode default to `True` if the `IPY_TEST_SIMPLE_PROMPT` - environment variable is set, or the current terminal is not a tty.""" - ).tag(config=True) + environment variable is set, or the current terminal is not a tty. + Thus the Default value reported in --help-all, or config will often + be incorrectly reported. + """, + ).tag(config=True) @property def debugger_cls(self):