format-docstring 0.1.3__tar.gz → 0.1.5__tar.gz

{format_docstring-0.1.3 → format_docstring-0.1.5}/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.5] - 2025-10-13
+
+- Added
+  - Support for `... ` (continuation of REPL lines) in the Examples section
+- Full diff
+  - https://github.com/jsh9/format-docstring/compare/0.1.4...0.1.5
+
+## [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

{format_docstring-0.1.3 → format_docstring-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: format-docstring
-Version: 0.1.3
+Version: 0.1.5
 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.1.3 → format_docstring-0.1.5}/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
@@ -101,7 +104,9 @@ def wrap_docstring_numpy(
             continue
 
         # In Examples, skip wrapping for REPL lines
-        if in_examples and stripped.startswith('>>> '):
+        if in_examples and (
+            stripped.startswith('>>> ') or stripped.startswith('... ')
+        ):
             temp_out.append(line)
             i += 1
             continue

{format_docstring-0.1.3 → format_docstring-0.1.5}/format_docstring.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: format-docstring
-Version: 0.1.3
+Version: 0.1.5
 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.1.3 → format_docstring-0.1.5}/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.3 → format_docstring-0.1.5}/pyproject.toml

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

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

@@ -0,0 +1,107 @@
+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
+
+class MyClass:
+    """
+    This is my class
+
+    Parameters
+    ----------
+    arg1 : int
+        Arg 1
+
+    Examples
+    -------------
+    Should not be wrapped, because of `>>> ` and `... `
+    >>> result = my_function(
+    ...     arg1=1,
+    ...     arg2=2,
+    ...     arg3=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
+
+class MyClass:
+    """
+    This is my class
+
+    Parameters
+    ----------
+    arg1 : int
+        Arg 1
+
+    Examples
+    --------
+    Should not be wrapped, because of `>>> ` and `... `
+    >>> result = my_function(
+    ...     arg1=1,
+    ...     arg2=2,
+    ...     arg3=3,
+    ... )
+    """
+    pass

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

@@ -0,0 +1,51 @@
+LINE_LENGTH: 79
+
+**********
+Example
+-----
+>>> a = 2
+>>> b = 3
+
+Examples
+----
+>>> a = 2
+>>> b = 3
+
+Examplesss
+----
+>>> a = 2
+>>> b = 3
+
+Examples
+-------------
+Should not be wrapped, because of `>>> ` and `... `
+>>> result = my_function(
+...     arg1=1,
+...     arg2=2,
+...     arg3=3,
+... )
+
+**********
+
+Examples
+--------
+>>> a = 2
+>>> b = 3
+
+Examples
+--------
+>>> a = 2
+>>> b = 3
+
+Examplesss
+----
+>>> a = 2 >>> b = 3
+
+Examples
+--------
+Should not be wrapped, because of `>>> ` and `... `
+>>> result = my_function(
+...     arg1=1,
+...     arg2=2,
+...     arg3=3,
+... )