From 401ab48beece37d803b5862f47d59f1043adacc7 Mon Sep 17 00:00:00 2001 From: Mustafa Haiderbhai Date: Mon, 10 Aug 2026 14:05:08 -0700 Subject: [PATCH] Add SI unit detail to agents.md --- AGENTS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/AGENTS.md b/AGENTS.md index 006b0bf30a17..2b5892a969cb 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -12,7 +12,7 @@ - Keep related public symbols discoverable through consistent prefixes. - Use concrete types for public interfaces where practical. - Use Google-style docstrings for public APIs. -- Document SI units for public physical quantities. +- Document SI units for public physical quantities in docstrings using inline `[unit]` notation (e.g. `Particle positions [m], shape [N, 3]`); use `[m or rad, depending on joint type]` where applicable, and skip non-physical fields (indices, counts, flags). - Keep comments brief and explain intent, constraints, or edge cases rather than restating code. - Do not remove or rename a public API without a prior deprecation and migration path. - Update public documentation when adding or changing public APIs.