Skip to content

fix docs highlight misalignment#5512

Open
frlai wants to merge 2 commits intoisaac-sim:developfrom
frlai:frlai/fix_leapp_docs_highlight
Open

fix docs highlight misalignment#5512
frlai wants to merge 2 commits intoisaac-sim:developfrom
frlai:frlai/fix_leapp_docs_highlight

Conversation

@frlai
Copy link
Copy Markdown
Collaborator

@frlai frlai commented May 6, 2026

Description

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 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 bug Something isn't working documentation Improvements or additions to documentation labels May 6, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 6, 2026

Greptile Summary

This PR corrects the emphasize-lines directive in an RST tutorial page so the highlighted lines match the actual LEAPP annotation code in the referenced Python script. The previous ranges (100-118, 85-88) were misaligned with the current file content.

  • Updates emphasize-lines to 20, 75-77, 92-105, which now correctly targets the leapp import (line 20), the output annotation block (lines 75-77), and the input annotation block (lines 92-105) in anymal_c_env.py.

Confidence Score: 5/5

Safe to merge — a one-line documentation-only fix with no runtime impact.

The change updates three line-range values in an RST emphasize-lines directive. Cross-checking against the actual Python file confirms the new ranges correctly land on the LEAPP import (line 20), the output-annotation block (lines 75-77), and the input-annotation block (lines 92-105). No logic, configuration, or API surface is touched.

No files require special attention.

Important Files Changed

Filename Overview
docs/source/tutorials/06_exporting/exporting_direct_workflow_policies_with_leapp.rst Updates emphasize-lines from 20, 100-118, 85-88 to 20, 75-77, 92-105 to correctly highlight LEAPP annotation lines in the referenced Python script

Reviews (1): Last reviewed commit: "fix docs highlight misalignment" | Re-trigger Greptile

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

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant