[Docs] use double backticks for inline literals #1014
Merged
Conversation
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
Contributor
OskarStark
commented
Nov 28, 2025
OskarStark
commented
| Q | A |
|---|---|
| Bug fix? | no |
| New feature? | no |
| Docs? | no |
| Issues | -- |
| License | MIT |
Changed single backticks to double backticks for inline code/literals in RST documentation, following reStructuredText conventions: - Single backticks are for interpreted text roles (references) - Double backticks are for inline literals (code, identifiers) 🤖 Generated with [Claude Code](https://claude.com/claude-code)
OskarStark
added a commit
to OskarStark/doctor-rst
that referenced
this pull request
Nov 28, 2025
This adds a new UseDoubleBackticksForInlineLiterals rule that detects inline literals wrapped in single backticks and suggests using double backticks instead. In RST, single backticks are for interpreted text roles (like :ref:, :doc:, :class:), while double backticks are for inline literals. The rule correctly skips RST roles and only flags standalone single backtick text like `vector` that should be ``vector``. See: symfony/ai#1014
4 tasks
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.