format-docstring 0.1.2__tar.gz → 0.1.4__tar.gz

{format_docstring-0.1.2 → format_docstring-0.1.4}/.pre-commit-config.yaml

@@ -37,6 +37,6 @@ repos:
         args: [--wrap, '79', --number]
         additional_dependencies: [mdformat-tables]
   - repo: https://github.com/jsh9/markdown-toc-creator
-    rev: 0.0.10
+    rev: 0.0.11
     hooks:
       - id: markdown-toc-creator

{format_docstring-0.1.2 → format_docstring-0.1.4}/CHANGELOG.md

@@ -6,6 +6,20 @@ The format is based on
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project
 adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.4] - 2025-10-12
+
+- Added
+  - Support for detecting misspelled section title: "Example"
+- Full diff
+  - https://github.com/jsh9/format-docstring/compare/0.1.3...0.1.4
+
+## [0.1.3] - 2025-10-12
+
+- Fixed
+  - A bug in counting line length for single-line docstrings
+- Full diff
+  - https://github.com/jsh9/format-docstring/compare/0.1.2...0.1.3
+
 ## [0.1.2] - 2025-10-08
 
 - Added

{format_docstring-0.1.2 → format_docstring-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: format-docstring
-Version: 0.1.2
+Version: 0.1.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>
@@ -109,7 +109,8 @@ def example_function(param1, param2, option='default'):
 
     Examples
     --------
-    Code examples with >>> prompts are preserved without wrapping:
+    Within the "Examples" section, code with >>> prompts are preserved without
+    wrapping:
 
     >>> result = example_function('test', 42, option='custom_value_with_a_very_long_name_that_exceeds_line_length')
     >>> print(result)
@@ -124,12 +125,17 @@ def example_function(param1, param2, option='default'):
     Params       Yes                 Signature lines preserved
     ===========  ==================  ===============================
 
-    Content following double colons (::) is preserved::
+    Contents following double colons (`::`) are preserved::
 
                   P(B|A) P(A)
-        P(A|B) = ---------------
+        P(A|B) = -------------
                       P(B)
 
+    Even if there isn't an extra blank line after `::`, the contents are still
+    preserved::
+            _______
+       σ = √ Var(X)
+
     Regular bullet lists are also preserved:
 
     - First bullet point that is intentionally long but not wrapped

{format_docstring-0.1.2 → format_docstring-0.1.4}/README.md

@@ -76,7 +76,8 @@ def example_function(param1, param2, option='default'):
 
     Examples
     --------
-    Code examples with >>> prompts are preserved without wrapping:
+    Within the "Examples" section, code with >>> prompts are preserved without
+    wrapping:
 
     >>> result = example_function('test', 42, option='custom_value_with_a_very_long_name_that_exceeds_line_length')
     >>> print(result)
@@ -91,12 +92,17 @@ def example_function(param1, param2, option='default'):
     Params       Yes                 Signature lines preserved
     ===========  ==================  ===============================
 
-    Content following double colons (::) is preserved::
+    Contents following double colons (`::`) are preserved::
 
                   P(B|A) P(A)
-        P(A|B) = ---------------
+        P(A|B) = -------------
                       P(B)
 
+    Even if there isn't an extra blank line after `::`, the contents are still
+    preserved::
+            _______
+       σ = √ Var(X)
+
     Regular bullet lists are also preserved:
 
     - First bullet point that is intentionally long but not wrapped

{format_docstring-0.1.2 → format_docstring-0.1.4}/format_docstring/line_wrap_numpy.py

@@ -57,7 +57,10 @@ def wrap_docstring_numpy(
         'raises',
         'raise',  # tolerate typo
     }
-    SECTION_EXAMPLES = {'examples'}
+    SECTION_EXAMPLES = {
+        'examples',
+        'example',  # tolerate typo
+    }
 
     temp_out: list[str | list[str]] = []
     in_code_fence: bool = False
@@ -377,7 +380,7 @@ def handle_single_line_docstring(
     if '\n' in whole_docstring_literal:  # multi-line: do not handle
         return whole_docstring_literal
 
-    if docstring_ending_col >= line_length:  # whole docstring exceeds limit
+    if docstring_ending_col > line_length:  # whole docstring exceeds limit
         num_leading_indent: int = docstring_starting_col
         parts: list[str] = whole_docstring_literal.split(docstring_content)
         prefix: str = parts[0]

{format_docstring-0.1.2 → format_docstring-0.1.4}/format_docstring.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: format-docstring
-Version: 0.1.2
+Version: 0.1.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>
@@ -109,7 +109,8 @@ def example_function(param1, param2, option='default'):
 
     Examples
     --------
-    Code examples with >>> prompts are preserved without wrapping:
+    Within the "Examples" section, code with >>> prompts are preserved without
+    wrapping:
 
     >>> result = example_function('test', 42, option='custom_value_with_a_very_long_name_that_exceeds_line_length')
     >>> print(result)
@@ -124,12 +125,17 @@ def example_function(param1, param2, option='default'):
     Params       Yes                 Signature lines preserved
     ===========  ==================  ===============================
 
-    Content following double colons (::) is preserved::
+    Contents following double colons (`::`) are preserved::
 
                   P(B|A) P(A)
-        P(A|B) = ---------------
+        P(A|B) = -------------
                       P(B)
 
+    Even if there isn't an extra blank line after `::`, the contents are still
+    preserved::
+            _______
+       σ = √ Var(X)
+
     Regular bullet lists are also preserved:
 
     - First bullet point that is intentionally long but not wrapped

{format_docstring-0.1.2 → format_docstring-0.1.4}/format_docstring.egg-info/SOURCES.txt

@@ -42,6 +42,7 @@ tests/test_data/end_to_end/numpy/colon_spacing_fix.txt
 tests/test_data/end_to_end/numpy/contents_that_are_not_wrapped.txt
 tests/test_data/end_to_end/numpy/default_value_standardization.txt
 tests/test_data/end_to_end/numpy/empty_lines_are_respected.txt
+tests/test_data/end_to_end/numpy/examples_section.txt
 tests/test_data/end_to_end/numpy/existing_linebreaks_should_not_be_respected.txt
 tests/test_data/end_to_end/numpy/four_level_nested_classes.txt
 tests/test_data/end_to_end/numpy/indent_four_levels_16_spaces_width_10.txt
@@ -73,6 +74,7 @@ tests/test_data/line_wrap/numpy/colon_spacing_fix.txt
 tests/test_data/line_wrap/numpy/contents_that_are_not_wrapped.txt
 tests/test_data/line_wrap/numpy/default_value_standardization.txt
 tests/test_data/line_wrap/numpy/empty_lines_are_respected.txt
+tests/test_data/line_wrap/numpy/examples_section.txt
 tests/test_data/line_wrap/numpy/existing_linebreaks_should_not_be_respected.txt
 tests/test_data/line_wrap/numpy/indent_four_levels_16_spaces_width_10.txt
 tests/test_data/line_wrap/numpy/indent_two_levels_8_spaces.txt

{format_docstring-0.1.2 → format_docstring-0.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "format-docstring"
-version = "0.1.2"
+version = "0.1.4"
 description = "A Python formatter to wrap/adjust docstring lines"
 readme = "README.md"
 license = {text = "MIT"}

format_docstring-0.1.4/tests/test_data/end_to_end/numpy/examples_section.txt

@@ -0,0 +1,67 @@
+LINE_LENGTH: 79
+
+**********
+def func1():
+    """
+    Example
+    -----
+    >>> a = 2
+    >>> b = 3
+    """
+    pass
+
+def func2():
+    """
+    Examples
+    ----
+    >>> a = 2
+    >>> b = 3
+    """
+    pass
+
+
+
+
+
+
+def func3():
+    """
+    Examplesss
+    ----
+    >>> a = 2
+    >>> b = 3
+    """
+    pass
+
+**********
+
+def func1():
+    """
+    Examples
+    --------
+    >>> a = 2
+    >>> b = 3
+    """
+    pass
+
+def func2():
+    """
+    Examples
+    --------
+    >>> a = 2
+    >>> b = 3
+    """
+    pass
+
+
+
+
+
+
+def func3():
+    """
+    Examplesss
+    ----
+    >>> a = 2 >>> b = 3
+    """
+    pass

{format_docstring-0.1.2 → format_docstring-0.1.4}/tests/test_data/end_to_end/numpy/single_line_docstring.txt

@@ -25,6 +25,16 @@ def func3():
                     """
                     pass
 
+
+def func4():
+    """This line has the right number of chars that it does not exceed limit"""
+    pass
+
+
+def func5():
+    r"""This line has the right number of chars that it exceeds limit by 1..."""
+    pass
+
 **********
 def func1():
     """
@@ -53,3 +63,15 @@ def func3():
                     This line is already formatted so we should not re-wrap it.
                     """
                     pass
+
+
+def func4():
+    """This line has the right number of chars that it does not exceed limit"""
+    pass
+
+
+def func5():
+    r"""
+    This line has the right number of chars that it exceeds limit by 1...
+    """
+    pass

format_docstring-0.1.4/tests/test_data/line_wrap/numpy/examples_section.txt

@@ -0,0 +1,33 @@
+LINE_LENGTH: 79
+
+**********
+Example
+-----
+>>> a = 2
+>>> b = 3
+
+Examples
+----
+>>> a = 2
+>>> b = 3
+
+Examplesss
+----
+>>> a = 2
+>>> b = 3
+
+**********
+
+Examples
+--------
+>>> a = 2
+>>> b = 3
+
+Examples
+--------
+>>> a = 2
+>>> b = 3
+
+Examplesss
+----
+>>> a = 2 >>> b = 3