godotengine / godotengine/godot-docs

Link to classes' source code from the class reference

Open
#4,314 5 comments 4 reactions 0 assignees View on GitHub
area:class reference enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

A lot of GDScript's documentation is lacking. A lot of explanations of functions don't explain much more than the name. I generally find that if I want to know what a function actually does, I've got to go to the CPP file that implements it in the backend. For instance, does lerp clamp t between 0 and 1? Apparently not - and that makes a big difference as far as bugs go if you're expecting otherwise. Can we have links directly to the CPPs from within the documentation?

Also... you know, it'd be a lot easier to contribute to the docs if you were using a wiki or something instead.

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.