Fix rST markup in the documentation about stubs #16888
Open
+3
−3
Conversation
This file contains 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
stof
commented
Nov 21, 2024
| @@ -573,7 +573,7 @@ Then notice the ``#if (PHP_VERSION_ID >= ...)`` conditions in the generated argi | |||
| return class_entry; | |||
| } | |||
| The preprocessor conditions are necessary because ``enum``s, ``readonly`` properties, and the | |||
| The preprocessor conditions are necessary because ``enum``, ``readonly`` properties, and the | |||
There was a problem hiding this comment.
rST requires the closing markup of a literal to be followed by a word boundary. It does not support closing a literal in the middle of a word.
the current markup produces output looking like that:
An alternative fix could be to write enums without using a literal.
There was a problem hiding this comment.
Or maybe "enum classes" or "enumerations (enum)".
|
maybe your CI should run |
|
Thank you for the PR!
That is probably a good idea. At least it should be incorporated in the makefile (see #16743). |
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.
No description provided.