Some grammar and punctuation enhancements in the class reference. #81097
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
MewPurPur
reviewed
Aug 29, 2023
doc/classes/RayCast3D.xml
Outdated
| @@ -37,7 +37,7 @@ | |||
| <method name="force_raycast_update"> | |||
| <return type="void" /> | |||
| <description> | |||
| Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next [code]_physics_process[/code] call, for example if the ray or its parent has changed state. | |||
| Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next [code]_physics_process[/code] call, for example, if the ray or its parent has changed state. | |||
There was a problem hiding this comment.
Here it's not clear to me if it's an improvement, as the added pause adds ambiguity about whether it's like "waiting for the next process call, for example" (it could be waiting for several things, and the next _physics_process call is one of them). I'd suggest rephrasing to avoid this.
Not a blocker of course, but if you decide to change this, remember to amend your commit with git commit --amend so you don't need to rebase.
There was a problem hiding this comment.
I fixed this (reverted the added comma), and the done the same thing for RayCast2D. I can give those files a better look later.
AcatXIo
force-pushed
the
grammar-enhancements
branch
from
80c6655
to
637f10a
Compare
Calinou
approved these changes
Aug 29, 2023
|
Thanks! And congrats for your first merged Godot contribution 🎉 |
|
Thank you as well! |
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.
My first PR ever.
Feel free to suggest further improvements.