Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
72 commits
Select commit Hold shift + click to select a range
70979f8
Copy test cases from "numpy"
jsh9 Dec 18, 2025
b507aa4
Manually adjust test cases
jsh9 Dec 18, 2025
aea1732
Fix more files in tests/test_data/end_to_end/google
jsh9 Dec 18, 2025
629cd06
Fix more test cases in tests/test_data/line_wrap/google
jsh9 Dec 18, 2025
f6989bf
Implement intermediate wrapper
jsh9 Dec 18, 2025
004f9fb
tweak playground.py
jsh9 Dec 18, 2025
c630070
Implement wrapping logic of the 2nd pass
jsh9 Dec 21, 2025
a472072
Don't add blank line after rST table and code block
jsh9 Dec 21, 2025
3c12cda
Add tests, etc.
jsh9 Dec 22, 2025
82410f1
remove spaces
jsh9 Dec 22, 2025
2c3fa03
Fix a bug with paragraphs within arg desc
jsh9 Dec 22, 2025
96a3c66
Fix multiple empty lines in the beginning
jsh9 Dec 22, 2025
d9511ac
Fix test case (empty_lines_are_respected.txt)
jsh9 Dec 22, 2025
2742f6b
Fix doctest handling
jsh9 Dec 22, 2025
710d4b5
Fix
jsh9 Feb 7, 2026
98a5295
More fixes
jsh9 Feb 8, 2026
cc021da
Fix logic for long type hints
jsh9 Feb 8, 2026
a4d1ace
Fix section title
jsh9 Feb 8, 2026
bd942af
Fix section header mapping
jsh9 Feb 8, 2026
7f92669
Fix wrapping within code fence
jsh9 Feb 8, 2026
6df9593
Double backtick pairs; fix URL issue
jsh9 Feb 8, 2026
54baf80
Fix expected docstring in contents_that_are_not_wrapped.txt
jsh9 Feb 8, 2026
c144e07
standardize default values
jsh9 Feb 8, 2026
6cb1bc2
Fix test case
jsh9 Feb 8, 2026
f7ea701
Fix typo in test case
jsh9 Feb 8, 2026
72ac19d
Fix wrapping typo in test case
jsh9 Feb 8, 2026
c93ef48
Remove/revert debugging changes
jsh9 Feb 8, 2026
4c780fd
Revert changes to playground
jsh9 Feb 8, 2026
14edc18
Use separate routes for Google style and numpy style
jsh9 Feb 8, 2026
79866c8
Revert "Fix test case"
jsh9 Feb 8, 2026
8b053cd
Revert "Fix expected docstring in contents_that_are_not_wrapped.txt"
jsh9 Feb 8, 2026
80de85a
Fix leng length of 1st line of docstrings
jsh9 Feb 9, 2026
2558da7
Make 1st line of docstring follow triple quotes
jsh9 Feb 9, 2026
6ef543b
Housekeeping
jsh9 Jun 9, 2026
5ea9492
Add google-style integration tests
jsh9 Jun 9, 2026
07410d8
Strengthen Google line-wrap fixtures and normalize malformed Google s…
jsh9 Jun 9, 2026
f26dbf9
Fix google end-to-end test cases
jsh9 Jun 9, 2026
33ece3d
autoformat
jsh9 Jun 9, 2026
8974f1d
linter autofix (all tests passed)
jsh9 Jun 9, 2026
cedb541
Tweak
jsh9 Jun 9, 2026
f210871
Tweak test cases
jsh9 Jun 10, 2026
478851b
Strengthened Google line-wrap tests against trailing whitespace regre…
jsh9 Jun 10, 2026
ba1360b
Fix Google and NumPy docstring wrapping regressions for fenced blocks…
jsh9 Jun 10, 2026
61adcee
Fix Google docstring wrapping for doctest output, label-like prose, a…
jsh9 Jun 10, 2026
10d0e4a
Fix docstring wrapping to preserve protected backticks, respect expli…
jsh9 Jun 11, 2026
ff84f49
Fix rST backtick normalization so literal blocks are preserved and do…
jsh9 Jun 12, 2026
6a52fc8
Fix rST backtick normalization to preserve literal and code directive…
jsh9 Jun 12, 2026
6998513
Fix return description preservation and centralize Google section han…
jsh9 Jun 14, 2026
faa3800
Fix return annotation sync to preserve colon-labeled descriptions in …
jsh9 Jun 14, 2026
307df3d
Normalize Google returns and yields as single-value descriptions and …
jsh9 Jun 14, 2026
60a694c
Preserve plain Python code in Examples sections and document expected…
jsh9 Jun 14, 2026
78a1190
Fix Google docstring wrapping after doctest blocks for plain example …
jsh9 Jun 14, 2026
5d7ff86
Fix Google docstring edge cases for Examples code backticks and rST r…
jsh9 Jun 15, 2026
e3204aa
Fix Google docstring wrapping to preserve indentation for argument de…
jsh9 Jun 15, 2026
980b98e
Fix Examples preservation for Google doctest header-like output and s…
jsh9 Jun 15, 2026
027b4a3
Fix docstring sync for type-commented class attribute defaults and It…
jsh9 Jun 15, 2026
c38c750
Refactor Google docstring wrapping internals to share summary compact…
jsh9 Jun 15, 2026
6aadd36
autoformat
jsh9 Jun 15, 2026
bd9eb79
Linter autofix
jsh9 Jun 16, 2026
9eb0f10
autoformat
jsh9 Jun 16, 2026
017f0c0
Fix linter issues
jsh9 Jun 16, 2026
cb25721
autoformat
jsh9 Jun 16, 2026
9b45db3
Fix pydoclint issues
jsh9 Jun 16, 2026
2039e9c
migrate from mypy to ty
jsh9 Jun 16, 2026
888e59e
autoformat
jsh9 Jun 16, 2026
f83af13
Fix linter errors
jsh9 Jun 16, 2026
94b580f
Refactor Google docstring wrapping internals to remove complexity sup…
jsh9 Jun 19, 2026
848e985
Update README
jsh9 Jun 19, 2026
51d7fb7
More updates to README
jsh9 Jun 19, 2026
01e619e
autoformat
jsh9 Jun 19, 2026
b437d45
Prepare 0.3.0 release and fix CLI config discovery from target paths.
jsh9 Jun 19, 2026
f293071
Update pyproject.toml with repo URL
jsh9 Jun 19, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -211,3 +211,5 @@ __marimo__/

# VS Code
.vscode/

uv.lock
24 changes: 24 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,30 @@ 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.3.0] - 2026-06-19

- Added
- Google-style docstring formatting for Python files and Jupyter notebooks
via `--docstring-style google` or `docstring_style = "google"` under
`[tool.format_docstring]`
- Google `Args:`, `Attributes:`, `Returns:`, and `Yields:` signature
synchronization from source annotations, defaults, class attributes, and
generator yield annotations
- Fixture coverage for Google line wrapping, end-to-end rewrites, notebook
rewrites, protected blocks, custom sections, and signature synchronization
- Changed
- Shared section and protected-block parsing so NumPy and Google formatting
preserve doctests, Python example code, fenced code, rST code blocks,
literal blocks, tables, and bullet lists more consistently
- README examples and configuration docs now describe NumPy and Google
behavior separately
- Development type checking now uses `ty` instead of `mypy`
- Fixed
- CLI config discovery now applies `pyproject.toml` settings found by walking
up from the target file or directory
- Full diff
- https://github.com/jsh9/format-docstring/compare/0.2.7...0.3.0

## [0.2.7] - 2025-12-04

- Fixed
Expand Down
Loading
Loading