pyproject.toml (1)

203-211: Typos configuration looks good, but consider adding typ exception.

The configuration appropriately excludes asset files and format-specific files from typo checking. The word exceptions are reasonable.

Consider adding typ to the identifiers list to prevent false positives, as it's commonly used as an abbreviation for "type" (especially to avoid shadowing Python's built-in):

 [tool.typos.default.extend-identifiers]
 PNGs = "PNGs"
+typ = "typ"

This would allow using typ as a variable name without triggering typo warnings, which is preferable to shadowing the built-in type function.

.pre-commit-config.yaml (1)

29-32: Consider updating typos to v1.38.1.

The latest stable version is v1.38.1 (released Oct 7, 2025), whereas v1.37.2 is currently specified. While the current version works, updating to the latest stable release is a good practice for staying current with improvements and fixes.

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

docs/guide/development.rst (2)

164-168: Clear introduction to the typos tool.

The section effectively explains the purpose and integration of typos with pre-commit.

Consider adding a brief example of the manual command for completeness:

 To proactively catch spelling mistakes, Newton uses the `typos <https://github.com/crate-ci/typos>`_ tool. Typos scans source files for common misspellings and is integrated into our pre-commit hooks, so spelling errors in both code and documentation are flagged when you run or install pre-commit (see above). You can also run ``typos`` manually if needed. Refer to the `typos documentation <https://github.com/crate-ci/typos>`_ for more details on usage and configuration options.
+
+To run typos manually:
+
+.. code-block:: console
+
+    typos

---

169-181: Comprehensive guide for handling false positives.

The subsection clearly explains the three configuration mechanisms and provides helpful guidance on updating pyproject.toml to suppress warnings.

Minor: Lines 182-185 contain excessive blank lines. Consider reducing to a single blank line for consistency with the rest of the document:

 When typos reports a word that is valid within the Newton codebase, you can add it to the appropriate section in ``pyproject.toml`` to suppress future warnings. After updating, re-run typos (or pre-commit) to confirm that the word is ignored. Use these options to keep the codebase clean while ensuring needed flexibility for accepted project-specific words and identifiers.
-
-
-
-
+
 Using a local Warp installation with uv

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

docs/guide/development.rst (1)

164-181: Well-structured documentation for typos integration and false-positive handling.

The new Typos section clearly explains the tool's purpose, pre-commit integration, and provides actionable guidance for managing false positives through file exclusions, word allowlists, and identifier allowlists. The examples (ba, HAA, PNGs, *.urdf) are concrete and contextually appropriate for a physics simulation library.

The placement after pre-commit install instructions is logical, and the documentation aligns well with the PR's goal of adding this information per reviewer feedback.

Optional improvement: Line 167 mentions running typos "manually if needed" but doesn't show the command. For completeness, consider adding a brief code example showing how to invoke typos directly (e.g., via uvx typos or typos .), similar to how the pre-commit section shows concrete commands above. This would help users who want to run the check outside the pre-commit workflow without consulting external documentation.

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro