[Validator] avoid broken rendering of inline types in UniqueEntity
#20962
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
This PR fixes an issue in the documentation where inline type annotations like | ``string`` | were not rendering correctly due to reStructuredText interpreting the | characters as substitution references. Changes: Replaced | ``string`` | with a more reliable format: boolean, string or array Ensures consistent rendering across Sphinx and other reST parsers This improves readability and avoids confusion when displaying valid type options in inline documentation.
OskarStark
changed the title
UniqueEntity
|
Wow! Very nice catch! I wasn't aware of this at all. Thanks! I searched in the docs and found another occurrence of this (it didn't happen in 6.4 branch but in upper branches, but I fixed it in 6.4 too: 90e7bf9) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR fixes a documentation issue where inline type annotations like
| string |were not rendering correctly. This happened because reStructuredText interprets text enclosed in | (e.g.,|string|) as a substitution reference, which requires a corresponding definition elsewhere in the document.Changes
Replaced ambiguous expressions like
| string |with clearer wording such as: boolean, string, or array.Ensures consistent rendering across Sphinx and other reStructuredText parsers.
Why this matters
This change improves the readability of inline documentation and avoids confusion by using a format that renders correctly and doesn't unintentionally trigger reStructuredText substitution rules.