Skip to content

[Agentic] Add SI unit detail to agents.md - #7008

Merged
kellyguo11 merged 1 commit into
isaac-sim:developfrom
StafaH:mh/agents-md2
Aug 10, 2026
Merged

[Agentic] Add SI unit detail to agents.md#7008
kellyguo11 merged 1 commit into
isaac-sim:developfrom
StafaH:mh/agents-md2

Conversation

@StafaH

@StafaH StafaH commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Description

Important

Confirm the pull request base before submitting. Target develop for all
contributions. The release/3.0.0-beta2 branch is a frozen stable landing
snapshot 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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (existing functionality will not work without user modification)
  • Documentation update

Screenshots

Please attach before and after screenshots of the change if applicable.

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have added a changelog fragment under source/<pkg>/changelog.d/ for every touched package (do not edit CHANGELOG.rst or bump extension.toml — CI handles that)
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

@StafaH
StafaH requested a review from a team August 10, 2026 21:05
@StafaH StafaH changed the title Add SI unit detail to agents.md [Agentic] Add SI unit detail to agents.md Aug 10, 2026

@isaaclab-review-bot isaaclab-review-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-apps

greptile-apps Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Clarifies the repository’s documentation standard for SI units in public API docstrings.

  • Specifies inline [unit] notation and provides an example.
  • Defines notation for joint-dependent linear or angular units.
  • Excludes non-physical fields such as indices, counts, and flags.

Confidence Score: 5/5

The 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

Filename Overview
AGENTS.md Expands the existing SI-unit documentation rule with clear notation, examples, and scope without affecting runtime behavior.

Reviews (1): Last reviewed commit: "Add SI unit detail to agents.md" | Re-trigger Greptile

@kellyguo11
kellyguo11 merged commit d3ab2bd into isaac-sim:develop Aug 10, 2026
44 checks passed
@StafaH
StafaH deleted the mh/agents-md2 branch August 13, 2026 22:17
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