format-docstring 0.2.3__py3-none-any.whl → 0.2.4__py3-none-any.whl

format_docstring/line_wrap_numpy.py

@@ -464,19 +464,39 @@ def _standardize_default_value(line: str) -> str:
     >>> _standardize_default_value('arg : bool, default: True')
     'arg : bool, default=True'
     """
+    colon_idx = line.find(':')
+    if colon_idx == -1:
+        return line
+
+    # `prefix` is everything before the 1st colon (param identifier portion).
+    # We leave `prefix` untouched so arg names like `default` aren't rewritten.
+    prefix = line[: colon_idx + 1]
+    after_colon = line[colon_idx + 1 :]
+
     # Check colon format first to avoid matching colons in space-based pattern
-    match = _DEFAULT_COLON_RE.match(line)
+    match = _DEFAULT_COLON_RE.match(after_colon)
     if match:
-        before = match.group(1).rstrip()
+        before = match.group(1)
+        if before.strip() == '':
+            return line
+
         default_value = match.group(2).strip()
-        return f'{before}, default={default_value}'
+        rebuilt_suffix = f'{before.rstrip()}, default={default_value}'
+        return f'{prefix}{rebuilt_suffix}'
 
     # Try space-separated format with optional "is"
-    match = _DEFAULT_SPACE_RE.match(line)
+    match = _DEFAULT_SPACE_RE.match(after_colon)
     if match:
-        before = match.group(1).rstrip()
+        before = match.group(1)
+        if before.strip() == '':
+            return line
+
+        # ``before`` still contains any annotation text; tightening the spacing
+        # here standardizes the ``", default=..."`` suffix while preserving
+        # whatever appeared to the left.
         default_value = match.group(2).strip()
-        return f'{before}, default={default_value}'
+        rebuilt_suffix = f'{before.rstrip()}, default={default_value}'
+        return f'{prefix}{rebuilt_suffix}'
 
     return line
 
@@ -730,12 +750,20 @@ def handle_single_line_docstring(
 # or certain punctuation (like > and . for `>>> ` and `... ` literals)
 # Note: We match [^`]+ (anything except backticks) and then check in the
 # replacement function whether it's an external link (contains < followed by >)
-# The opening backtick must not be immediately followed by _ or __ (to avoid
-# matching the trailing backtick of cross-references like `text`_ or `text`__)
 _RST_BACKTICK_PATTERN = re.compile(
     r'(?:^|(?<=\s)|(?<=\()|(?<=[>.]))(?::[\w-]+:)?`(?!_)([^`]+)`(?!`)(?!__)(?!_)'
 )
 
+# 2nd-stage fixer for ``__dunder__`` names that slipped past the main pattern
+# because the literal starts with an underscore. Negative lookbehinds/aheads
+# ensure we only touch isolated single-backtick literals and leave
+# cross-references (`name`_ / `name`__) alone.
+_DUNDER_LITERAL_PATTERN = re.compile(
+    r'(?<!`)`(__[A-Za-z0-9_]+__)`(?!`)(?!_)(?!__)'
+)
+# Replacement wraps the captured dunder name (group 1) with double backticks.
+_DUNDER_LITERAL_REPLACEMENT = r'``\1``'
+
 
 def _fix_rst_backticks(docstring: str) -> str:
     """
@@ -857,6 +885,11 @@ def _fix_rst_backticks(docstring: str) -> str:
     # Process the entire docstring (with REPL lines protected)
     protected_docstring = ''.join(protected_lines)
     processed = _RST_BACKTICK_PATTERN.sub(replace_func, protected_docstring)
+    # Upgrade remaining single-backtick ``__dunder__`` literals to double
+    # backticks; they are safe literals (not targets or refs) after the guards.
+    processed = _DUNDER_LITERAL_PATTERN.sub(
+        _DUNDER_LITERAL_REPLACEMENT, processed
+    )
 
     # Restore REPL lines
     result_lines = processed.splitlines(keepends=True)

{format_docstring-0.2.3.dist-info → format_docstring-0.2.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: format-docstring
-Version: 0.2.3
+Version: 0.2.4
 Summary: A Python formatter to wrap/adjust docstring lines
 Author-email: jsh9 <25124332+jsh9@users.noreply.github.com>
 Maintainer-email: jsh9 <25124332+jsh9@users.noreply.github.com>

{format_docstring-0.2.3.dist-info → format_docstring-0.2.4.dist-info}/RECORD

@@ -3,13 +3,13 @@ format_docstring/base_fixer.py,sha256=8SVkyn2ZSwQr3-7GzxxmHVSYMHymdj6AchBxd53IA1
 format_docstring/config.py,sha256=OwVasV5uX2y4gMajzY-2CIcmaSKuVUm3GxWDUdbWDcc,5586
 format_docstring/docstring_rewriter.py,sha256=LFLPd1pMyPBQCkkNTlcMcgHWyuOLOiyJNYjz1HOeVyY,21315
 format_docstring/line_wrap_google.py,sha256=iJdpMwCB97H3CUatmkGAexJ_J8FeWv1kMEv1UzzUvjM,587
-format_docstring/line_wrap_numpy.py,sha256=djBk_Q_FU65HZzJlKkLdBuPLUA3fbCMnc4_cmmIfaUU,29015
+format_docstring/line_wrap_numpy.py,sha256=0Vof7ct5KAA-f_pYv94xP_xRQfKGg7YR9X8_o9gImUM,30333
 format_docstring/line_wrap_utils.py,sha256=q59n26gzbnNgi9sWAIyX-M4MTbi5tITXVrKjJDK-Vao,28178
 format_docstring/main_jupyter.py,sha256=3mHBeT-BVlF5R1m8xpF3OxOzQTReR6NnPjbN80eo18E,6300
 format_docstring/main_py.py,sha256=S4zZCvJMZn8ZoDx2zYWPikKmH5-of10UTc5sad5W5v8,4597
-format_docstring-0.2.3.dist-info/licenses/LICENSE,sha256=UNm_-hqU-1dAB3bLytP6wvGtUeitoJde2xzb5wgVYn0,1061
-format_docstring-0.2.3.dist-info/METADATA,sha256=9PWb1nJJ-p_bszpvAJuY1hvD3ilkgCMp0CU77g4R6SE,15453
-format_docstring-0.2.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-format_docstring-0.2.3.dist-info/entry_points.txt,sha256=Re2iHTzfgKJgeXDga5Z4bGNPtWGmxupOdzTolwn52sk,129
-format_docstring-0.2.3.dist-info/top_level.txt,sha256=NXPwfHm_1YwwGuetwtK3pJv0jXwXelqPTNCFpm5LQyE,17
-format_docstring-0.2.3.dist-info/RECORD,,
+format_docstring-0.2.4.dist-info/licenses/LICENSE,sha256=UNm_-hqU-1dAB3bLytP6wvGtUeitoJde2xzb5wgVYn0,1061
+format_docstring-0.2.4.dist-info/METADATA,sha256=4Ei4SrGYksCOoMFJc_BNVtfD3LAh800jdpYPyFgy6dU,15453
+format_docstring-0.2.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+format_docstring-0.2.4.dist-info/entry_points.txt,sha256=Re2iHTzfgKJgeXDga5Z4bGNPtWGmxupOdzTolwn52sk,129
+format_docstring-0.2.4.dist-info/top_level.txt,sha256=NXPwfHm_1YwwGuetwtK3pJv0jXwXelqPTNCFpm5LQyE,17
+format_docstring-0.2.4.dist-info/RECORD,,