search

godotengine / godot-docs

Godot Engine official documentation
https://docs.godotengine.org
Other
3.6k stars 2.97k forks source link

Provide examples for clarity on proper syntax #6209

Open Tolly24 opened 1 year ago

Tolly24 commented 1 year ago

Your Godot version: 3.5 Issue description: I'm learning Godot(came from Gamemaker Studio 2) and I love it and GDScript but what I'm always struggling with the docs is having examples of how to use anything in. There are pages with examples but not not consistently. As someone without programming knowledge beforehand. It's really hard to know how to use something properly when you don't have a background knowledge. That's what I loved about the docs in GMS2, there's a detailed explaination in text for everything and at the end there's always an example to show the proper syntax. image

URL to the documentation page (if already existing):

Calinou commented 1 year ago

Code samples are only added for methods whose usage is not trivial (for example, adding new items to a Tree, or making an HTTP request).

Calling one-liner methods should not have code samples to avoid bloating the class reference.