Repository navigation
docs: Fix typos in docstrings and README - #816
Merged
Merged
Conversation
Fixes 22 typos and small grammar mistakes, found by reading the codebase and running codespell. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
ValerianRey
added
the
cc: docs
github-actions
Bot
changed the title
github-actions
Bot
changed the title
ValerianRey
marked this pull request as ready for review
October 7, 2026 16:20
ValerianRey
requested review from
a team,
KhusPatel4450,
PierreQuinton and
ppraneth
as code owners
October 7, 2026 16:20
ValerianRey
enabled auto-merge (squash)
October 7, 2026 16:20
ppraneth
approved these changes
Oct 7, 2026
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
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.
Fixes 22 typos and small grammar mistakes, found by reading the codebase and running
codespell:linalg), stray)and "it's interface" → "its interface" (autogram), "aDropoutlayers are" → "Dropoutlayers are" and "Transformers, which use …, has to be used" → "have to be used" (Engine), "sums of the rows" → "sums the rows" (Sum), "shows train" → "shows how to train" (UW), "diection" → "direction" (SDMGradWeighting, also rewrapped since the line was over 100 characters), missing periods (CRMOGMWeighting,jac_to_grad), and double spaces (AlignedMTL,UPGrad).FairGrad's install hint says "Install them with" (it lists 2 dependencies), like the 3 other hints.:params module:(JacobianComputer), "a AutogramNode", "inputs keys" (RequirementError),half_shape + half_shape[::-1](reshape), thegramianparameter ofmovedim, and a missing verb in a comment ofaccumulate_jacs.Apart from the wording of the FairGrad error message, nothing changes at runtime. The unit tests, docs build and doctests pass.
🤖 Generated with Claude Code