Skip to content

Conversation

@pascal-roth
Copy link
Collaborator

Description

Remove dependency on IsaacSim prim_utils for integration of new simulation engines like newton.

Type of change

  • Dependency removal

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

@github-actions github-actions bot added enhancement New feature or request isaac-lab Related to Isaac Lab team labels Nov 3, 2025
@pascal-roth pascal-roth self-assigned this Nov 3, 2025
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Greptile Overview

Greptile Summary

This PR updates a docstring reference in visualization_markers.py to align documentation with the actual implementation. The reference to isaacsim.core.utils.create_prim has been replaced with isaaclab.sim.utils.prims.create_prim.

Context:

  • In commit 8e411a8, the prim_utils functionality was reimplemented in IsaacLab at isaaclab/sim/utils/prims.py
  • The actual code implementation (in spawner modules) already uses the IsaacLab version via import isaaclab.sim.utils.prims
  • This PR simply updates the docstring to reflect the correct module path that's already in use

Changes:

  • Updated docstring reference from isaacsim.core.utils.create_prim to isaaclab.sim.utils.prims.create_prim in VisualizationMarkers class documentation

This is a documentation-only change with no functional impact.

Confidence Score: 5/5

  • This PR is safe to merge with no risk - it's a documentation-only change that fixes an outdated reference
  • Score reflects that this is purely a documentation update with zero functional changes. The docstring reference is being updated to match the actual implementation that was already changed in a previous commit (8e411a8). The new reference correctly points to the IsaacLab prim_utils module that is already being used by the codebase.
  • No files require special attention

Important Files Changed

File Analysis

Filename Score Overview
source/isaaclab/isaaclab/markers/visualization_markers.py 5/5 Documentation-only update: replaced outdated isaacsim.core.utils.create_prim reference with correct isaaclab.sim.utils.prims.create_prim reference

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Doc as Documentation
    participant Code as Implementation Code
    participant IsaacLab as isaaclab.sim.utils.prims
    
    Note over Dev,IsaacLab: PR #3924: Documentation Update
    
    Dev->>Doc: Update docstring reference
    Doc->>Doc: Change isaacsim.core.utils.create_prim
    Doc->>Doc: To isaaclab.sim.utils.prims.create_prim
    
    Note over Code,IsaacLab: Implementation (already updated in commit 8e411a8)
    Code->>IsaacLab: Already imports prim_utils
    Code->>IsaacLab: Uses create_prim() from IsaacLab
    
    Note over Dev,IsaacLab: Result: Documentation now matches implementation
Loading

1 file reviewed, no comments

Edit Code Review Agent Settings | Greptile

@pascal-roth pascal-roth moved this to In review in Isaac Lab Nov 3, 2025
@ooctipus
Copy link
Collaborator

ooctipus commented Nov 5, 2025

Looks like tests are failing 👀

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

Labels

enhancement New feature or request isaac-lab Related to Isaac Lab team

Projects

Status: In review

Development

Successfully merging this pull request may close these issues.

2 participants