diff --git a/src/docformatter/format.py b/src/docformatter/format.py index f3b1719..2c1b55b 100644 --- a/src/docformatter/format.py +++ b/src/docformatter/format.py @@ -1065,8 +1065,13 @@ def _do_format_docstring( # noqa PLR0911 if not self.args.force_wrap and ( _patterns.is_type_of_list( summary, - self.args.non_strict, - self.args.style, + # A wrapped summary can look like a list after the following + # prose is removed. Keep the heuristic for single-line summaries. + strict=self.args.non_strict + or ( + "\n" in summary and not _patterns.is_heuristic_list(contents, False) + ), + style=self.args.style, ) or _patterns.do_find_links(summary) ): diff --git a/tests/test_oss_regression_265.py b/tests/test_oss_regression_265.py new file mode 100644 index 0000000..5fa59c8 --- /dev/null +++ b/tests/test_oss_regression_265.py @@ -0,0 +1,32 @@ +"""Regression for a summary sentence split across short source lines.""" + +import sys + +import pytest + +from docformatter.format import Formatter + + +@pytest.mark.integration +@pytest.mark.parametrize("args", [[""]]) +@pytest.mark.parametrize("continuation_indent", ["", " "]) +def test_wrapped_summary_sentence(test_args, continuation_indent): + source = ( + "def launch_rocket():\n" + ' """Launch\n' + f"{continuation_indent}the\n" + f'{continuation_indent}rocket. Go colonize space."""\n' + ) + expected = ( + "def launch_rocket():\n" + ' """Launch the rocket.\n' + "\n" + " Go colonize space.\n" + ' """\n' + ) + formatter = Formatter(test_args, sys.stderr, sys.stdin, sys.stdout) + + formatted = formatter._do_format_code(source) + + assert formatted == expected + assert formatter._do_format_code(formatted) == expected