PyPI - format-docstring - Versions diffs - 0.1.0__tar.gz → 0.1.1__tar.gz - Mend

@@ -1,6 +1,7 @@
 from __future__ import annotations
 import re
+import textwrap
 from format_docstring.line_wrap_utils import (
     add_leading_indent,
@@ -358,7 +359,7 @@ def _standardize_default_value(line: str) -> str:
     return line
-def handle_single_line_docstring_that_is_a_bit_too_long(
+def handle_single_line_docstring(
         whole_docstring_literal: str | None,
         docstring_content: str,
         docstring_starting_col: int,
@@ -382,6 +383,18 @@ def handle_single_line_docstring_that_is_a_bit_too_long(
         prefix: str = parts[0]
         postfix: str = parts[-1]
         indent: str = ' ' * num_leading_indent
-        return f'{prefix}\n{indent}{docstring_content}\n{indent}{postfix}'
+        # We need to wrap `docstring_content` here because single-line
+        # docstrings don't get wrapped anywhere else.
+        tw: textwrap.TextWrapper = textwrap.TextWrapper(
+            width=line_length - num_leading_indent,
+            break_long_words=False,
+            break_on_hyphens=False,
+            replace_whitespace=False,
+            drop_whitespace=True,
+        )
+        wrapped_list: list[str] = tw.wrap(docstring_content)
+        wrapped: str = textwrap.indent('\n'.join(wrapped_list), indent)
+        return f'{prefix}\n{wrapped}\n{indent}{postfix}'
     return whole_docstring_literal

@@ -0,0 +1,30 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+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.1] - 2025-10-06
+- Fixed
+  - A bug where single-line docstrings exceeding length limit aren't handled
+- Full diff
+  - https://github.com/jsh9/format-docstring/compare/0.1.0...0.1.1
+## [0.1.0] - 2025-10-06
+- Added
+  - Initial release of format-docstring
+  - Support for NumPy-style docstring formatting
+  - Limited support for Google-style docstrings
+  - CLI tools: `format-docstring` and `format-docstring-jupyter`
+  - Configuration via `pyproject.toml` with `[tool.format_docstring]` section
+  - Options for line length, docstring style, and file exclusion patterns
+  - Pre-commit hooks for Python files and Jupyter notebooks
+  - Comprehensive test suite with pytest
+  - Type checking with mypy
+  - Support for Python 3.10-3.12
+- Full diff
+  - N/A

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: format-docstring
-Version: 0.1.0
+Version: 0.1.1
 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>

@@ -4,7 +4,7 @@ import ast
 from format_docstring.line_wrap_google import wrap_docstring_google
 from format_docstring.line_wrap_numpy import (
-    handle_single_line_docstring_that_is_a_bit_too_long,
+    handle_single_line_docstring,
     wrap_docstring_numpy,
 )
@@ -168,7 +168,7 @@ def build_replacement_docstring(
     new_literal: str | None = rebuild_literal(original_literal, wrapped)
-    new_literal = handle_single_line_docstring_that_is_a_bit_too_long(
+    new_literal = handle_single_line_docstring(
         whole_docstring_literal=new_literal,
         docstring_content=wrapped,
         docstring_starting_col=val.col_offset,

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: format-docstring
-Version: 0.1.0
+Version: 0.1.1
 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>

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

@@ -61,6 +61,12 @@ def func8():
     nf of pf qf rf sf tf uf vf wf xf yf zf 1f 2f 3f 4f 5f 6f 7f 8f 9f 0f af bf cf df ef ff gf hf if jf kf lf mf"""
     pass
+def func9():
+    def get_scores(self) -> np.ndarray:
+        """Return entire score array, with 'None' for scores that haven't been calculated."""
+        return self.scores
 **********
 def func1():
@@ -133,3 +139,12 @@ def func8():
     df ef ff gf hf if jf kf lf mf
     """
     pass
+def func9():
+    def get_scores(self) -> np.ndarray:
+        """
+        Return entire score array, with 'None' for scores that haven't been
+        calculated.
+        """
+        return self.scores

format-docstring 0.1.0__tar.gz → 0.1.1__tar.gz