Clean up more [b]Example:[/b] lines from the class reference
#99020
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
Mickeon
commented
Nov 10, 2024
Comment on lines
+145
to
+151
| If the [param event] inherits [InputEventMouse], this method will [b]not[/b] be called when: | ||
| - the control's [member mouse_filter] is set to [constant MOUSE_FILTER_IGNORE]; | ||
| - the control is obstructed by another control on top, that doesn't have [member mouse_filter] set to [constant MOUSE_FILTER_IGNORE]; | ||
| - the control's parent has [member mouse_filter] set to [constant MOUSE_FILTER_STOP] or has accepted the event; | ||
| - the control's parent has [member clip_contents] enabled and the [param event]'s position is outside the parent's rectangle; | ||
| - the [param event]'s position is outside the control (see [method _has_point]). | ||
| [b]Note:[/b] The [param event]'s position is relative to this control's origin. |
There was a problem hiding this comment.
Not exactly happy about this, still, but changing it too much would be way out of scope.
Mickeon
commented
Nov 10, 2024
| @@ -22,7 +22,7 @@ | |||
| AddChild(scene); | |||
| [/csharp] | |||
| [/codeblocks] | |||
| [b]Example of saving a node with different owners:[/b] The following example creates 3 objects: [Node2D] ([code]node[/code]), [RigidBody2D] ([code]body[/code]) and [CollisionObject2D] ([code]collision[/code]). [code]collision[/code] is a child of [code]body[/code] which is a child of [code]node[/code]. Only [code]body[/code] is owned by [code]node[/code] and [method pack] will therefore only save those two nodes, but not [code]collision[/code]. | |||
| [b]Example:[/b] Save a node with different owners. The following example creates 3 objects: [Node2D] ([code]node[/code]), [RigidBody2D] ([code]body[/code]) and [CollisionObject2D] ([code]collision[/code]). [code]collision[/code] is a child of [code]body[/code] which is a child of [code]node[/code]. Only [code]body[/code] is owned by [code]node[/code] and [method pack] will therefore only save those two nodes, but not [code]collision[/code]. | |||
There was a problem hiding this comment.
This entire line is downright awful, but changing it now would be way out of scope. There's a lot to... unpack here.
Mickeon
commented
Nov 10, 2024
| @@ -102,7 +102,7 @@ | |||
| <param index="0" name="name" type="StringName" /> | |||
| <description> | |||
| Similar to [method get_setting], but applies feature tag overrides if any exists and is valid. | |||
| [b]Example:[/b] If the setting override [code]"application/config/name.windows"[/code] exists, and the following code is executed on a [i]Windows[/i] operating system, the overridden setting is printed instead: | |||
| [b]Example:[/b] If the setting override [code]"application/config/name.windows"[/code] exists, and the following code is executed on a [i]Windows[/i] operating system, the overridden setting is printed instead: | |||
There was a problem hiding this comment.
This seems to replace U+0009 Character Tabulation with U+0020 Space, which is correct. No idea how that tab got there.
There was a problem hiding this comment.
I was the one that modified this line, but that tab shouldn't be allowed in the first place. @Repiteo mentioned he wanted to take a look at preventing this in the future.
Because I didn't check for tabs there may be more like this.
And indeed there are tabs here.
Mickeon
force-pushed
the
documentation-example-pruning-2
branch
from
eff5d28 to
1b99030
Compare
Mickeon
force-pushed
the
documentation-example-pruning-2
branch
2 times, most recently
from
4292da5 to
99da18d
Compare
mhilbrunner
reviewed
Nov 11, 2024
doc/classes/HTTPRequest.xml
Outdated
| @@ -80,7 +80,7 @@ | |||
| } | |||
| [/csharp] | |||
| [/codeblocks] | |||
| [b]Example of loading and displaying an image using HTTPRequest:[/b] | |||
| [b]Example:[/b] Load and display an image using [HTTPRequest]: | |||
There was a problem hiding this comment.
"Example: Load an image using [HTTPRequest] and display it" would be more correct, but more cumbersome, so... whatever, let's probably leave as is.
There was a problem hiding this comment.
No, that seems appropriate to me. I can change it.
mhilbrunner
approved these changes
Nov 11, 2024
Mickeon
force-pushed
the
documentation-example-pruning-2
branch
from
99da18d to
db385eb
Compare
Mickeon
force-pushed
the
documentation-example-pruning-2
branch
from
db385eb to
932b1c4
Compare
|
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.
Continuation of #95749, see prior PR for similar reasoning.
This PR continues the effort to standardise the
[b]Example:[/b]somewhat, instead of bolding the entire line describing the example below.It also replaces some lines similar to
For example:with[b]Example:[/b]. This is not exhaustive at all, as oftentimes doing this change makes readability worse, but whenever possible... sure, why not?The descriptions affected by this have received tweaks to justify a localization update. Notably:
Control._gui_input()has been changed drasticallySyntaxHighlighter.get_line_syntax_highlighting()has been changed drastically