Migrate docstrings from NumPy to Google convention#1140
Merged
hmgaudecker merged 3 commits intomainfrom Mar 19, 2026
Merged
Conversation
Switch pydocstyle.convention from "numpy" to "google" in pyproject.toml and convert docstrings in plot/dag/__init__.py. Closes #1139 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Documentation build overview
Show files changed (2 files in total): 📝 2 modified | ➕ 0 added | ➖ 0 deleted
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
MImmesberger
approved these changes
Mar 19, 2026
Collaborator
Author
|
Good catch, thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
pydocstyle.conventionfrom"numpy"to"google"inpyproject.tomlsrc/gettsim/plot/dag/__init__.py(the only gettsim file with NumPy-style sections)Closes #1139
Test plan
pixi run ty— all checks passedpixi run ty-jax— all checks passedprek run --all-files— all passedpixi run -e py314 tests -n 7— 2471 passedgrep -rn "^ ----------" src/— no remaining NumPy-style dashes🤖 Generated with Claude Code