Update help text for `--pdbcls` to match behavior (closes #8655) (#8656)

* Clarify help text for --pdbcls * Add changelog entry for --pdbcls
2021-05-11 05:04:50 -04:00 · 2021-05-11 05:04:50 -04:00 · 822624c252
parent 0a07b71046
commit 822624c252
2 changed files with 2 additions and 1 deletions
--- a/changelog/8655.doc.rst
+++ b/changelog/8655.doc.rst
@ -0,0 +1 @@
+Help text for ``--pdbcls`` more accurately reflects the option's behavior.
--- a/src/_pytest/debugging.py
+++ b/src/_pytest/debugging.py
@ -53,7 +53,7 @@ def pytest_addoption(parser: Parser) -> None:
        dest="usepdb_cls",
        metavar="modulename:classname",
        type=_validate_usepdb_cls,
-        help="start a custom interactive Python debugger on errors. "
+        help="specify a custom interactive Python debugger for use with --pdb."
        "For example: --pdbcls=IPython.terminal.debugger:TerminalPdb",
    )
    group._addoption(
				`@ -0,0 +1 @@`
				Help text for ``--pdbcls`` more accurately reflects the option's behavior.