godotengine / godotengine/godot-docs

Show inherited members in API reference

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

Description

Well Look like godot engine docs does not have anything common with reality.
Why i think so.
Simple example :

```
func _input(event):
if event is InputEventMouseMotion:
print("Mouse Motion at: ", event.position)
```

As you see after VERY long search in docs method **_input** inherited from **Node** class
void _input ( InputEvent event ) virtual
so now we know that variable _event_ is class InputEvent.
So now we go to description of class **InputEvent** to find description for property **event.position** and nothing written in documentation about it.
Ok lets try to search in parent classes which we see in docs for **InputEvent**
> Inherits: Resource < Reference < Object

None of such classes have property **position**. Ok. Lets try to search in classes inherited by.
After long research you suddenly find that position property described in class **InputEventMouseMotion** but in description for **InputEvent** you not see that InputEvent was inherited by InputEventMouse. Such problems in documentation create a lot of confuses.
This is only one simple example . But such situation is almost everywhere.

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.