Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

_ready() description under "Methods and static functions" incorrect in GDScript style guide. #9912

Open
GrzegorzGrzelczyk opened this issue Sep 5, 2024 · 2 comments
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation

Comments

@GrzegorzGrzelczyk
Copy link

First issue in my life! Not 100% sure I'm even right. Throw in trash if nothing needs to be corrected.

Your Godot version:
4.3

Issue description:
One paragraph under "Methods and static functions" in GDScript style guide is incorrect.

IS:
"Start with the _init() callback method, that the engine will call upon creating the object in memory. Follow with the _ready() callback, that Godot calls when it adds a node to the scene tree."

I think according to what i read earlier that the second sentence describes _enter_tree() callback not the _ready() one. So instead of two sentences describing _init() and _ready() (incorrectly), we should have three that describe _init(), _enter_tree() and _ready() in that order.

URL to the documentation page:
https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_styleguide.html#methods-and-static-functions

@AThousandShips
Copy link
Member

It is correct, but slightly vague, the exact description would be "when it adds a node to the scene tree for the first time"

But there's nothing wrong here and it talks about _ready not _enter_tree, otherwise the code example wouldn't use _ready

@AThousandShips AThousandShips removed the bug label Sep 5, 2024
@GrzegorzGrzelczyk
Copy link
Author

Maybe this list confused me a bit:

12. optional built-in virtual _init method
13. optional built-in virtual _enter_tree() method
14. built-in virtual _ready method

My bad.

@skyace65 skyace65 added the area:manual Issues and PRs related to the Manual/Tutorials section of the documentation label Sep 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation
Projects
None yet
Development

No branches or pull requests

3 participants