fix: fix tests that failed after updating regex's

As docformatter becomes more strict in identifying patterns and handling the various patterns that are identified, some of the older tests are failing.  These tests fail because the patterns in the test strings are not strictly reST, Sphinx, etc.

Author: weibullguy

README.rst

@@ -199,6 +199,12 @@ Do you use *docformatter*?  What style docstrings do you use?  Add some badges t
     .. image:: https://img.shields.io/badge/%20style-google-3666d6.svg
         :target: https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings
 
+Assistance
+==========
+``docformatter`` has an IRC channel on `Libera.Chat`_ in the `#docformatter`_ room.
+ .. _`Libera.Chat`: https://libera.chat
+ .. _`#docformatter`: https://web.libera.chat/#docformatter
+
 Issues
 ======
 

src/docformatter/constants.py

@@ -76,10 +76,10 @@
 OPTION_REGEX = r"^ {0,}-{1,2}[\S ]+ \w+"
 """Regular expression to use for finding option lists."""
 
-REST_INLINE_REGEX = (
-    r"(?<!^\.{2} )(:)*([*]{1,2}|_?[`]{1,2}|[|\[])[\w <>:.-]+([*]{1,"
-    r"2}|[`]{1,2}_?|[|]|[\]]_?)"
-)
+REST_DIRECTIVE_REGEX = r"^( {0,}\.\. .+?:{1,2}.*\n(?:[ \t]{1,}.*\n|\n)*)"
+"""Regular expression to use for finding reST directives."""
+
+REST_INLINE_REGEX = r"(?<!^\.{2} )(:)*([*]{1,2}|_?[`]{1,2}|[|\[])[\w <>:.-]+([*]{1,2}|[`]{1,2}_?|[|]|[\]]_?)"  # noqa: E501
 """Regular expression to use for finding inline reST markup."""
 
 REST_SECTION_REGEX = (

src/docformatter/patterns/rest.py

@@ -31,12 +31,11 @@
 import re
 
 # docformatter Package Imports
-from docformatter.constants import REST_INLINE_REGEX
+from docformatter.constants import REST_DIRECTIVE_REGEX, REST_INLINE_REGEX
 
 
 def do_find_rest_directives(
     text: str,
-    indent: int = 0,
 ) -> list[tuple[int, int]]:
     """Determine if docstring contains any reST directives.
 
@@ -52,10 +51,7 @@ def do_find_rest_directives(
     bool
         True if the docstring is a reST directive, False otherwise.
     """
-    _rest_directive_regex = (
-        r"^( {0,}\.\. .+?::.*\n(?:[ \t]{" + str(indent + 1) + r",}.*\n|\n)*)"
-    )
-    _rest_iter = re.finditer(_rest_directive_regex, text, flags=re.MULTILINE)
+    _rest_iter = re.finditer(REST_DIRECTIVE_REGEX, text, flags=re.MULTILINE)
     return [(_rest.start(0), _rest.end(0)) for _rest in _rest_iter]
 
 

src/docformatter/strings.py

@@ -402,7 +402,7 @@ def do_split_summary(lines) -> List[str]:
     # in a multiline docstring.  Thus, insert a newline and then the remaining text to
     # the list of lines.
     if rest_text:
-        _pos = 1 if len(lines) >= 2 else 0  # noqa: PLR2004
+        _pos = 1 if len(lines) >= 3 else 0  # noqa: PLR2004
         _leading_spaces = " " * (len(lines[_pos]) - len(lines[_pos].lstrip()))
         _internal_spaces = " " * (_pos)
         lines.insert(1, "")

src/docformatter/wrappers/description.py

@@ -89,7 +89,7 @@ def do_wrap_description(  # noqa: PLR0913
         not force_wrap
         and (
             _patterns.is_some_sort_of_code(text)
-            or _patterns.do_find_rest_directives(text, len(indentation))
+            or _patterns.do_find_rest_directives(text)
             or _patterns.is_type_of_list(text, strict, style)
         )
     ):

tests/_data/string_files/description_wrappers.toml

@@ -85,11 +85,11 @@ expected = """
 instring = """
 This is a long docstring containing some reST directives.
 
-.. note
+.. note::
 This is a note in the reST dialog.
 """
 expected = """
     This is a long docstring containing some reST directives.
 
-    .. note
+    .. note::
     This is a note in the reST dialog."""

tests/_data/string_files/do_format_code.toml

@@ -50,15 +50,15 @@ source='''
     class TestClass:
         """This is a class docstring.
         :cvar test_int: a class attribute.
-        ..py.method: big_method()
+        .. py:method:: big_method()
         """
 '''
 expected='''
     class TestClass:
         """This is a class docstring.
 
         :cvar test_int: a class attribute.
-        ..py.method: big_method()
+        .. py:method:: big_method()
         """
 
 '''
@@ -678,15 +678,15 @@ class TestClass:
 
     """This is a class docstring.
     :cvar test_int: a class attribute.
-    ..py.method: big_method()
+    ..py:method:: big_method()
     """
 '''
 expected='''
 class TestClass:
     """This is a class docstring.
 
     :cvar test_int: a class attribute.
-    ..py.method: big_method()
+    ..py:method:: big_method()
     """
 
 '''
@@ -870,8 +870,8 @@ expected='''def mixed_links():
 
     Once ``mpm`` is located, we can rely on it to produce the main output of the plugin.
 
-    The output must supports both `Xbar dialect
-    <https://github.com/matryer/xbar-plugins/blob/main/CONTRIBUTING.md#plugin-api>`_
+    The output must supports both
+    `Xbar dialect <https://github.com/matryer/xbar-plugins/blob/main/CONTRIBUTING.md#plugin-api>`_
     and `SwiftBar dialect <https://github.com/swiftbar/SwiftBar#plugin-api>`_.
     """
 

tests/_data/string_files/do_format_docstrings.toml

@@ -487,7 +487,8 @@ source='''"""This is another docstring with `a link`_.
     """'''
 expected='''"""This is another docstring with `a link`_.
 
-    .. a link: http://www.reliqual.com/wiki/how_to_use_ramstk/verification_and_validation_module/index.html.
+    .. a link:
+    http://www.reliqual.com/wiki/how_to_use_ramstk/verification_and_validation_module/index.html.
     """'''
 
 [issue_75_2]

tests/_data/string_files/string_functions.toml

@@ -116,11 +116,11 @@ expected = ["This e.g. a sentence.", ""]
 
 [do_split_multi_sentence_summary]   # See issue #283.
 instring = ["This is a sentence. This is another.", ""]
-expected = ["This is a sentence.","","This is another."]
+expected = ["This is a sentence.", "This is another.", ""]
 
 [do_split_multi_sentence_summary_2]   # See issue #283.
 instring = ["This e.g. a sentence. This is another.", ""]
-expected = ["This e.g. a sentence.", "", "This is another."]
+expected = ["This e.g. a sentence.", "This is another.", ""]
 
 [do_split_description_url_outside_param]
 instring = "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmm https://mmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmm\n:param a:mmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmm"