Skip to content

Fix escape character notation in RstCheatSheet #507

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.

Sign up for GitHub

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
linawolf merged 3 commits into from
Feb 3, 2026
Merged

Fix escape character notation in RstCheatSheet #507

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b71a7fb
Fix escape character notation in RstCheatSheet
franzholz Jan 31, 2026
9c41f03
Apply suggestion from @linawolf
linawolf Feb 3, 2026
a5b1896
Apply suggestion from @linawolf
linawolf Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Documentation/Basics/RstCheatSheet.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ Escape characters
=================

If you want to use a character, which would create some special reST markup,
with its normal meaning, you must escape it with a prepended "\".
with its normal meaning, you must escape it with a prepended :rst:`\`.

For example surrounding text with "*" signs normally makes it show up in italics. By
escaping the special characters "*" you make the stars normal text characters:
Expand Down