godotengine / godotengine/godot-docs

New property description (old member variables) is wasting space

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

Description

Not sure if this is the best place, but here goes. I feel like showing the additional whitespace and setters/getters in the docs made the docs less usable. The setters/getters take half of a variable's documentation space and the extra spacing makes it hard to get an overview of how a class works. Compare 3.1/latest
![image](https://user-images.githubusercontent.com/35355161/54855622-7e26f600-4ccd-11e9-8815-945079da10d3.png)
with 3.0, where all the information fits in one page,
![image](https://user-images.githubusercontent.com/35355161/54855763-ff7e8880-4ccd-11e9-8db0-f71485dc5dab.png)

Some of the setters/getters are not obvious from the name, see
![image](https://user-images.githubusercontent.com/35355161/54855680-b9c1c000-4ccd-11e9-956b-c45ccd203166.png)
but as far as I understand, their usage in GDScript has been discouraged in favor of simply accessing variables directly, so maybe adding them to the Property section would be better, as so?
![image](https://user-images.githubusercontent.com/35355161/54856180-9435b600-4ccf-11e9-9e1f-f39d7dece870.png)

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.