[Agentic] Add SI unit detail to agents.md - #7008
Conversation
There was a problem hiding this comment.
Isaac Lab Review Bot
This PR narrowly refines the root AGENTS.md SI-unit guidance by prescribing inline [unit] notation, clarifying mixed linear/angular joint quantities, and excluding non-physical fields such as indices, counts, and flags.
- Design and architecture: The change keeps SI-unit documentation guidance single-sourced in the existing top-level development rules and introduces no competing directory-level convention or runtime architecture change.
- API: No source API, export, type, default, registration, or packaging surface is changed. The new wording defines a documentation convention for public physical quantities without altering runtime behavior.
- Implementation: The revised bullet is consistent with the adjacent Google-style docstring requirement and the repository rule to document SI units. No source package is touched, so package changelog requirements do not apply. The denser single bullet is a minor readability tradeoff but does not require correction before merge.
No blocking issues. No inline issue met the actionable-evidence threshold; the assessment above records the review feedback.
Automated review; human maintainers own approval decisions.
Greptile SummaryClarifies the repository’s documentation standard for SI units in public API docstrings.
Confidence Score: 5/5The documentation-only clarification appears safe to merge. The change consistently refines an existing contributor guideline and introduces no runtime, build, security, or public API behavior changes. Important Files Changed
Reviews (1): Last reviewed commit: "Add SI unit detail to agents.md" | Re-trigger Greptile |
Description
Important
Confirm the pull request base before submitting. Target
developfor allcontributions. The
release/3.0.0-beta2branch is a frozen stable landingsnapshot and is not used for ongoing maintenance.
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
List any dependencies that are required for this change.
Fixes # (issue)
Type of change
Screenshots
Please attach before and after screenshots of the change if applicable.
Checklist
pre-commitchecks with./isaaclab.sh --formatsource/<pkg>/changelog.d/for every touched package (do not editCHANGELOG.rstor bumpextension.toml— CI handles that)CONTRIBUTORS.mdor my name already exists there