Style: Add WARNING: as new comment admonition
#96923
Merged
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
Riteo
reviewed
Sep 12, 2024
| @@ -3962,9 +3962,9 @@ LRESULT DisplayServerWindows::WndProc(HWND hWnd, UINT uMsg, WPARAM wParam, LPARA | |||
| } | |||
| } | |||
|
|
|||
| // WARNING: we get called with events before the window is registered in our collection | |||
| // WARNING: We get called with events before the window is registered in our collection | |||
There was a problem hiding this comment.
some stuff got edited to be uppercase after the colon while some other not. Is there a hard rule on this?
There was a problem hiding this comment.
They should all be uppercase, as the documentation specifies; any lowercase instances are ones that slipped through the cracks.
Repiteo
force-pushed
the
style/warning-admonition
branch
from
da7dcbb
to
17d5244
Compare
Repiteo
force-pushed
the
style/warning-admonition
branch
from
17d5244
to
32c83a2
Compare
akien-mga
approved these changes
Sep 25, 2024
|
Thanks! |
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.
WARNING:to list of admonitions godot-docs#9947Integrates the change from the above PR to the codebase on existing commented warnings; updated syntax and formatting where appropriate.