Make SplitSummaryAndDocstringFormatter non-optional

docs/usage.rst

@@ -9,8 +9,8 @@ Current usage of ``pydocstringformatter``:
                                 [--exit-code]
                                 [--max-summary-lines MAX_SUMMARY_LINES]
                                 [--summary-quotes-same-line]
-                                [--split-summary-body  --no-split-summary-body]
                                 [--strip-whitespaces  --no-strip-whitespaces]
+                                [--split-summary-body  --no-split-summary-body]
                                 [--linewrap-full-docstring  --no-linewrap-full-docstring]
                                 [--beginning-quotes  --no-beginning-quotes]
                                 [--closing-quotes  --no-closing-quotes]
@@ -50,6 +50,14 @@ Current usage of ``pydocstringformatter``:
                             Activate or deactivate strip-whitespaces: Strip 1)
                             docstring start, 2) docstring end and 3) end of line.
                             (default: True)
+      --split-summary-body, --no-split-summary-body
+                            Activate or deactivate split-summary-body: Split the
+                            summary and body of a docstring based on a period and
+                            max length. The maximum length of a summary can be set
+                            with the --max-summary-lines option. This formatter is
+                            currently optional as its considered somwehat
+                            opinionated and might require major refactoring for
+                            existing projects. (default: True)
       --beginning-quotes, --no-beginning-quotes
                             Activate or deactivate beginning-quotes: Fix the
                             position of the opening quotes. (default: True)
@@ -72,14 +80,6 @@ Current usage of ``pydocstringformatter``:
     optional formatters:
       these formatters are turned off by default
 
-      --split-summary-body, --no-split-summary-body
-                            Activate or deactivate split-summary-body: Split the
-                            summary and body of a docstring based on a period and
-                            max length. The maximum length of a summary can be set
-                            with the --max-summary-lines option. This formatter is
-                            currently optional as its considered somwehat
-                            opinionated and might require major refactoring for
-                            existing projects. (default: False)
       --linewrap-full-docstring, --no-linewrap-full-docstring
                             Activate or deactivate linewrap-full-docstring:
                             Linewrap the docstring by the pre-defined line length.

pydocstringformatter/formatting/__init__.py

@@ -21,8 +21,8 @@
 #   Determine if multi-line or single line and position quotes accordingly
 #   String manipulation in which being multi-line or single line matters
 FORMATTERS: list[Formatter] = [
-    SplitSummaryAndDocstringFormatter(),
     StripWhitespacesFormatter(),
+    SplitSummaryAndDocstringFormatter(),
     LineWrapperFormatter(),
     BeginningQuotesFormatter(),
     ClosingQuotesFormatter(),

pydocstringformatter/formatting/_utils.py

@@ -0,0 +1,5 @@
+def is_rst_title(summary: str) -> bool:
+    """Check if the second line of a summary is one recurring character."""
+    # If second line is one recurring character we're dealing with a rst title
+    last_line = summary.splitlines()[-1].lstrip()
+    return last_line.count(last_line[0]) == len(last_line)

pydocstringformatter/formatting/formatter.py

@@ -3,6 +3,7 @@
 import tokenize
 from typing import Literal
 
+from pydocstringformatter.formatting import _utils
 from pydocstringformatter.formatting.base import (
     StringAndQuotesFormatter,
     StringFormatter,
@@ -139,9 +140,7 @@ def _treat_summary(
         if summary[-1] in self.END_OF_SENTENCE_PUNCTUATION:
             return summary
 
-        # If second line is one recurring character we're dealing with a rst title
-        last_line = summary.splitlines()[-1].lstrip()
-        if last_line.count(last_line[0]) == len(last_line):
+        if _utils.is_rst_title(summary):
             return summary
 
         return summary + "."
@@ -157,8 +156,6 @@ class SplitSummaryAndDocstringFormatter(SummaryFormatter):
     """
 
     name = "split-summary-body"
-    # TODO(#68): Make this non-optional
-    optional = True
 
     end_of_sentence_period = re.compile(
         r"""
@@ -181,11 +178,14 @@ def _treat_summary(
         """Split a summary and body if there is a period after the summary."""
         new_summary = None
 
+        if _utils.is_rst_title(summary):
+            return summary
+
         # Try to split on period
         if match := re.search(self.end_of_sentence_period, summary):
             index = match.start()
 
-            if summary[: index - 1].count("\n") < self.config.max_summary_lines:
+            if summary[:index].count("\n") < self.config.max_summary_lines:
                 if len(summary) == index + 1:
                     new_summary = summary
 

tests/data/format/beginning_quote/class_docstring.py.out

@@ -1,23 +1,27 @@
 class MyClass:
-    """A multi-line
-    docstring.
+    """A multi-line.
+
+    docstring
     """
 
     class InnerClass:
         """
-        A multi-line
-        docstring.
+        A multi-line.
+
+        docstring
         """
 
 
 class MyClass:
-    """A multi-line
-    docstring.
+    """A multi-line.
+
+    docstring
     """
 
     class InnerClass:
-        """A multi-line
-        docstring.
+        """A multi-line.
+
+        docstring
         """
 
 

tests/data/format/beginning_quote/function_docstrings.py.out

@@ -7,11 +7,13 @@ def func():
 
 def func():
     """
-    A multi-line
-    docstring.
+    A multi-line.
+
+    docstring
     """
 
     def inner_func():
-        """A multi-line
-        docstring.
+        """A multi-line.
+
+        docstring
         """

tests/data/format/beginning_quote/multi_line_no_push/class_docstring.py.out

@@ -1,22 +1,26 @@
 class MyClass:
     """
-    A multi-line
-    docstring.
+    A multi-line.
+
+    docstring
     """
 
     class InnerClass:
         """
-        A multi-line
-        docstring.
+        A multi-line.
+
+        docstring
         """
 
 
 class MyClass:
-    """A multi-line
-    docstring.
+    """A multi-line.
+
+    docstring
     """
 
     class InnerClass:
-        """A multi-line
-        docstring.
+        """A multi-line.
+
+        docstring
         """

tests/data/format/beginning_quote/multi_line_no_push/function_docstrings.py.out

@@ -1,11 +1,13 @@
 def func():
     """
-    A multi-line
-    docstring.
+    A multi-line.
+
+    docstring
     """
 
     def inner_func():
         """
-        A multi-line
-        docstring.
+        A multi-line.
+
+        docstring
         """

tests/data/format/beginning_quote/multi_line_no_push/variable_docstring.py.out

@@ -1,5 +1,6 @@
 MYVAR = 1
 """
-A multi-line
-docstring.
+A multi-line.
+
+docstring
 """

tests/data/format/beginning_quote/multi_line_push/class_docstring.py.out

@@ -1,20 +1,24 @@
 class MyClass:
-    """A multi-line
-    docstring.
+    """A multi-line.
+
+    docstring
     """
 
     class InnerClass:
-        """A multi-line
-        docstring.
+        """A multi-line.
+
+        docstring
         """
 
 
 class MyClass:
-    """A multi-line
-    docstring.
+    """A multi-line.
+
+    docstring
     """
 
     class InnerClass:
-        """A multi-line
-        docstring.
+        """A multi-line.
+
+        docstring
         """

tests/data/format/beginning_quote/multi_line_push/function_docstrings.py.out

@@ -1,9 +1,11 @@
 def func():
-    """A multi-line
-    docstring.
+    """A multi-line.
+
+    docstring
     """
 
     def inner_func():
-        """A multi-line
-        docstring.
+        """A multi-line.
+
+        docstring
         """

tests/data/format/beginning_quote/multi_line_push/variable_docstring.py.out

@@ -1,4 +1,5 @@
 MYVAR = 1
-"""A multi-line
-docstring.
+"""A multi-line.
+
+docstring
 """

tests/data/format/beginning_quote/variable_docstring.py.out

@@ -1,4 +1,5 @@
 MYVAR = 1
-"""A multi-line
-docstring.
+"""A multi-line.
+
+docstring
 """

tests/data/format/capitalization_first_letter/class_docstring.py.out

@@ -1,23 +1,27 @@
 class MyClass:
-    """A multi-line
-    docstring.
+    """A multi-line.
+
+    docstring
     """
 
     class InnerClass:
         """
-        A multi-line
-        docstring.
+        A multi-line.
+
+        docstring
         """
 
 
 class MyClass:
-    """A multi-line
-    docstring.
+    """A multi-line.
+
+    docstring
     """
 
     class InnerClass:
-        """A multi-line
-        docstring.
+        """A multi-line.
+
+        docstring
         """
 
 

tests/data/format/capitalization_first_letter/function_docstrings.py.out

@@ -15,11 +15,13 @@ def func(named_parameter: str) -> None:
 
 def func():
     """
-    A multi-line
-    docstring.
+    A multi-line.
+
+    docstring
     """
 
     def inner_func():
-        """A multi-line
-        docstring.
+        """A multi-line.
+
+        docstring
         """

tests/data/format/capitalization_first_letter/variable_docstring.py.out

@@ -1,10 +1,12 @@
 MYVAR = 1
 """
-A multi-line
-docstring.
+A multi-line.
+
+docstring
 """
 
 MYVAR = 1
-"""A multi-line
-docstring.
+"""A multi-line.
+
+docstring
 """

tests/data/format/final_period/class_docstring.py.out

@@ -6,13 +6,15 @@ class MyClass:
 
 
 class MyClass:
-    """A multi-line
-    docstring.
+    """A multi-line.
+
+    docstring
     """
 
     class InnerClass:
-        """A multi-line
-        docstring.
+        """A multi-line.
+
+        docstring
         """
 
 

tests/data/format/final_period/exotic_line_ending.py.out

@@ -9,5 +9,4 @@ def function():
     """This has peculiar line ending;
 
     but it should not matter.
-
     """

tests/data/format/final_period/function_docstrings.py.out

@@ -6,13 +6,15 @@ def func()
 
 
 def func()
-    """A multi-line
-    docstring.
+    """A multi-line.
+
+    docstring
     """
 
     def inner_func()
-        """A multi-line
-        docstring.
+        """A multi-line.
+
+        docstring
         """