Docs: asterisk does not always mean italics#3349
Merged
snowman2 merged 1 commit intorasterio:mainfrom May 20, 2025
Merged
Conversation
snowman2
approved these changes
May 20, 2025
Member
|
Thanks @adamjstewart 👍 |
snowman2
pushed a commit
that referenced
this pull request
Nov 6, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When Sphinx sees an asterisk, it assumes you want italics. However, asterisks also appear in code or as math. We need to either convert these to formal code/math or escape the asterisk to prevent the following warnings in RtD CI:
Before
After