godotengine / godotengine/godot-docs

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

Open
#9,912 2 comments 0 reactions 0 assignees View on GitHub
area:manual
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.