Merge branch 'main' into bugfix/empty_section

Author: jspaezp

.pre-commit-config.yaml

@@ -3,7 +3,7 @@ repos:
     rev: v4.3.0
     hooks:
       - id: trailing-whitespace
-        exclude: "tests/data/format/whitespace_stripper|tests/data/format/quotes_type|tests/data/format/newlines|tests/test_config.py"
+        exclude: "tests/data/format/no_whitespace_stripper|tests/data/format/whitespace_stripper|tests/data/format/quotes_type|tests/data/format/newlines|tests/test_config.py"
       - id: end-of-file-fixer
         exclude: "tests/data/format/newlines"
       - id: check-yaml
@@ -42,7 +42,7 @@ repos:
         exclude: *test-data
         additional_dependencies: [flake8-typing-imports==1.10.1]
   - repo: https://github.com/pycqa/pylint
-    rev: v2.15.0
+    rev: v2.15.2
     hooks:
       - id: pylint
         exclude: *test-data

pydocstringformatter/_formatting/_utils.py

@@ -5,5 +5,6 @@
 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()
+    if not (last_line := summary.splitlines()[-1].lstrip()):
+        return False
     return last_line.count(last_line[0]) == len(last_line)

pydocstringformatter/_formatting/formatters_default.py

@@ -88,7 +88,8 @@ def treat_summary(
                 # ending quotes
                 line_length -= quotes_length + 1
 
-        summary_lines = summary.splitlines()
+        if not (summary_lines := summary.splitlines()):
+            summary_lines = [""]
 
         new_summary = "\n".join(
             textwrap.wrap(

tests/data/format/no_whitespace_stripper/module_docstring.args

@@ -0,0 +1 @@
+--no-strip-whitespaces

tests/data/format/no_whitespace_stripper/module_docstring.py

@@ -0,0 +1,12 @@
+"""  A multi-line  
+docstring  
+"""
+
+"""  A multi-line  
+docstring  
+   """
+
+"""  My docstring.  
+    
+   My indented section  
+  """

tests/data/format/no_whitespace_stripper/module_docstring.py.out

@@ -0,0 +1,18 @@
+"""  A multi-line  .
+
+docstring  
+"""
+
+"""  A multi-line  .
+
+docstring  
+   
+"""
+
+"""  My docstring.
+
+ 
+    
+   My indented section  
+  
+"""

tests/data/format/summary_splitter/empty_summary.args

@@ -0,0 +1 @@
+--linewrap-full-docstring

tests/data/format/summary_splitter/empty_summary.py

@@ -0,0 +1,2 @@
+class GithubIssue151:
+    """ """

tests/data/format/summary_splitter/empty_summary.py.out

@@ -0,0 +1,2 @@
+class GithubIssue151:
+    """"""