Skip to content

Tighten docstrings: drop em-dashes and AI-ish filler#41

Merged
bwengals merged 1 commit into
mainfrom
docstring-sweep
Jun 24, 2026
Merged

Tighten docstrings: drop em-dashes and AI-ish filler#41
bwengals merged 1 commit into
mainfrom
docstring-sweep

Conversation

@bwengals

@bwengals bwengals commented Jun 23, 2026

Copy link
Copy Markdown
Collaborator

A docstring and comment cleanup across ptgp/ to make the prose read less like an AI wrote it. No code, signatures, or behavior change.

What changed

  • Removed every em-dash (the "—" character) from docstrings and comments. The repo now has zero. Replacements are periods, commas, semicolons, or colons as reads best.
  • Dropped marketing/filler phrasing ("Batteries-included", "suitable for use with", a stray "simply", a "Useful for").
  • Kept all math, formulas, tensor shapes, parameter/return descriptions, and the non-obvious caveats and warnings (jitter/PSD rationale, NaN-gradient clamp, FITC "not a lower bound", condition-number health notes, VFF out-of-domain caveats, scipy/shared-variable interop notes, and so on).

18 files touched, a near 1:1 line swap (61/61). Pure docstring/comment edits.

Test plan

  • pytest tests/ 265 passed
  • pre-commit run --all-files clean (ruff 0.5.5 + ruff-format)
  • scripts/run_mypy.py 37/37 pass
  • grep -rn "—" ptgp/ returns nothing

📚 Documentation preview 📚: https://ptgp--41.org.readthedocs.build/en/41/

@bwengals bwengals merged commit d1e35ed into main Jun 24, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants