Skip to content

Fix termination manager reset comments#6006

Open
NeoZng wants to merge 1 commit into
isaac-sim:mainfrom
NeoZng:fix-termination-manager-comments
Open

Fix termination manager reset comments#6006
NeoZng wants to merge 1 commit into
isaac-sim:mainfrom
NeoZng:fix-termination-manager-comments

Conversation

@NeoZng

@NeoZng NeoZng commented Jun 6, 2026

Copy link
Copy Markdown

Description

Fixes two stale comments in TerminationManager.reset() that referred to reward terms even
though the method reports and resets termination terms. This keeps the docstring and inline comment consistent with the termination manager behavior.

Fixes # (issue)

Type of change

  • Documentation update

Checklist

  • I have read and understood the [contribution guidelines](https://isaac-sim.github.io/
    IsaacLab/main/source/refs/contributing.html)
  • 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 updated the changelog and the corresponding version in the extension's config/ extension.toml file
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

Note: This is a comment-only documentation fix, so no runtime tests, changelog, or version
updates were added.

@github-actions github-actions Bot added bug Something isn't working isaac-lab Related to Isaac Lab team labels Jun 6, 2026
@greptile-apps

greptile-apps Bot commented Jun 6, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR corrects two stale copy-paste comments in TerminationManager.reset() that mistakenly referred to "reward terms" instead of "termination terms", making the docstring return description and inline comment consistent with what the method actually does.

  • Docstring Returns: line updated from "individual reward terms" to "individual termination terms".
  • Inline comment # reset all the reward terms updated to # reset all the termination terms.

Confidence Score: 5/5

This is a comment-only change with no runtime impact; safe to merge.

Both changed lines are documentation comments inside reset(). No logic, control flow, or data is altered — the two corrections simply align the docstring return description and the inline comment with the method's actual behavior.

No files require special attention.

Important Files Changed

Filename Overview
source/isaaclab/isaaclab/managers/termination_manager.py Two comment-only fixes correcting "reward terms" → "termination terms" in the reset() method; no logic changes.

Sequence Diagram

sequenceDiagram
    participant Caller
    participant TerminationManager

    Caller->>TerminationManager: reset(env_ids)
    TerminationManager->>TerminationManager: compute episodic termination stats
    TerminationManager->>TerminationManager: reset class-based termination terms
    TerminationManager-->>Caller: "dict[str, Tensor] (Episode_Termination/* keys)"
Loading

Reviews (1): Last reviewed commit: "Fix termination manager reset comments" | Re-trigger Greptile

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review Summary

Verdict: LGTM

This is a clean, targeted documentation fix. The two stale comments in TerminationManager.reset() incorrectly referenced "reward terms" — clearly a copy-paste artifact from RewardManager which shares a similar structure. Both corrections are accurate:

  1. Docstring (L137): "Dictionary of episodic sum of individual reward terms""...termination terms" — matches the actual return value which reports Episode_Termination/ keyed stats.
  2. Inline comment (L148): "reset all the reward terms""...termination terms" — correctly describes the loop resetting self._class_term_cfgs (termination term configurations).

Minor observation (non-blocking)

The PR description's docstring for the reset() method says "Returns the episodic counts of individual termination terms" while the return value description now says "episodic sum". Both are slightly imprecise — the actual value is float().mean(dim=0) (i.e., the mean across environments, not a sum or count). This pre-dates this PR and isn't something to block on, but could be worth a follow-up if the author is interested.

No functional impact, CI passes. Good catch! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working isaac-lab Related to Isaac Lab team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant