Replaces deprecated --headless with --viz none in mimic tests#5378
Replaces deprecated --headless with --viz none in mimic tests#5378njawale42 wants to merge 3 commits intoisaac-sim:developfrom
Conversation
There was a problem hiding this comment.
🤖 Isaac Lab Review Bot
Summary
This PR replaces the deprecated --headless CLI flag with --viz none across 5 mimic test files (6 occurrences total) to silence AppLauncher deprecation warnings. The change is straightforward and correct — both flags achieve headless execution, but --viz none is the current recommended approach.
Architecture Impact
Self-contained. The changes only affect test subprocess commands that invoke external scripts (annotate_demos.py, generate_dataset.py). No core framework code is modified. The invoked scripts already support --viz none as the non-deprecated alternative to --headless.
Implementation Verdict
Minor fixes needed — The code change is correct, but there's an RST formatting error in the changelog.
Test Coverage
This PR modifies test files themselves (fixing deprecation warnings in test infrastructure). The tests will self-validate — if the --viz none flag weren't properly supported by the target scripts, these tests would fail. No additional test coverage needed.
CI Status
No CI checks available yet. Once CI runs, the mimic tests (@pytest.mark.isaacsim_ci) should pass, which would validate the flag replacement works correctly.
Findings
🔴 Critical: source/isaaclab_mimic/docs/CHANGELOG.rst:7 — RST formatting error will break documentation build
The Changed section underline uses ^^^^^ (5 characters) but must match the length of the header text "Changed" (7 characters). RST requires the underline to be at least as long as the text above it:
Changed
^^^^^Should be:
Changed
^^^^^^^This will cause Sphinx documentation build failures.
🔵 Improvement: source/isaaclab_mimic/docs/CHANGELOG.rst:9 — Changelog entry uses future date
The version 1.2.5 (2026-04-23) has a date in 2026, which appears to be a typo (should likely be 2025). This is consistent with other entries in the file that also use 2026/2025 dates, so this may be intentional for the project, but worth verifying the date convention.
🔵 Improvement: Consistency observation across test files
The change is applied consistently across all 5 test files. The pattern "--viz", "none" (as two separate list elements) is correct for subprocess argument passing and matches how other flags are structured in these command lists.
Greptile SummaryThis PR replaces the deprecated Confidence Score: 5/5Safe to merge; the only finding is a minor RST underline formatting issue in the CHANGELOG. All code changes are straightforward, consistent, and correct. The single finding (RST underline length) is a P2 documentation style issue that does not affect runtime behavior. source/isaaclab_mimic/docs/CHANGELOG.rst — RST underline for "Changed" is one character short. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Test file invokes subprocess] --> B{Build command list}
B --> C["--viz"]
C --> D["none"]
D --> E[run_script / subprocess executes]
E --> F[AppLauncher receives --viz none]
F --> G[Headless mode, no deprecation warning]
style C fill:#90EE90
style D fill:#90EE90
Reviews (1): Last reviewed commit: "Bumps isaaclab_mimic to 1.2.5 with --hea..." | Re-trigger Greptile |
| ~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Changed | ||
| ^^^^^ |
There was a problem hiding this comment.
RST underline too short for section header
In reStructuredText, the underline must be at least as long as the title text. "Changed" is 7 characters, but the underline ^^^^^ is only 5 characters — this will produce a Sphinx/docutils warning (or error depending on config) when the docs are built. All other "Changed" headers in this file use ^^^^^^^.
| ^^^^^ | |
| ^^^^^^^ |
Description
This PR replaces
--headlesswith--viz nonein the subprocess command built by each test.Files updated:
source/isaaclab_mimic/test/test_generate_dataset_franka_state.py(2 occurrences)source/isaaclab_mimic/test/test_generate_dataset_franka_visuomotor.py(1 occurrence)source/isaaclab_mimic/test/test_generate_dataset_gr1t2_nutpour.py(1 occurrence)source/isaaclab_mimic/test/test_generate_dataset_gr1t2_pickplace.py(1 occurrence)source/isaaclab_mimic/test/test_generate_dataset_skillgen.py(1 occurrence)Total: 5 files, 6 subprocess commands updated.
Type of change
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there