Skip to content

[docs] [fix] Skip spell checker on bash code #3071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jun 18, 2025

Conversation

khalatepradnya
Copy link
Collaborator

@khalatepradnya khalatepradnya commented Jun 16, 2025

|:spellcheck-disable:| and |:spellcheck-enable:| get rendered verbatim in code block and adding substitutions causes spell checker to fail.

Fixes following:

image

After fix:

image

@khalatepradnya khalatepradnya added the documentation Improvements or additions to documentation label Jun 17, 2025
@khalatepradnya khalatepradnya changed the title [docs] [fix] Make both the spell checker and RST renderer happy. [docs] [fix] Skip spell checker on bash code Jun 17, 2025
@khalatepradnya khalatepradnya requested a review from mitchdz June 17, 2025 20:04
@khalatepradnya khalatepradnya enabled auto-merge (squash) June 17, 2025 20:15
@khalatepradnya khalatepradnya requested a review from sacpis June 17, 2025 22:36
Copy link
Collaborator

@sacpis sacpis left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @khalatepradnya.

@khalatepradnya khalatepradnya merged commit b276e79 into NVIDIA:main Jun 18, 2025
380 of 382 checks passed
@khalatepradnya khalatepradnya deleted the orca-docs branch June 18, 2025 21:58
github-actions bot pushed a commit that referenced this pull request Jun 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants