Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sort and group theme properties in docs, improve formatting for theme and enums #55520

Conversation

YuriSizov
Copy link
Contributor

This PR makes sure that theme properties in the documentation always follow the same order: they are grouped and ordered by their data type (color, icon, stylebox), and then sorted by name. This affects both the built-in help and the online docs (because order in the XMLs have also been updated).

Additionally, both theme properties and enums/constants have received an update to their look and their description is now on a new line. This is required because a lot of those entries have rather large descriptions which are hard to read otherwise.

Here's how the theme properties look now:
godot windows tools 64_2021-12-01_21-00-45

A good example of why it's needed for enums as well:
godot windows tools 64_2021-12-01_20-59-41

And a few comparisons:

@dalexeev
Copy link
Member

dalexeev commented Dec 2, 2021

Maybe it would be better to make a table with columns Name, Value, Description (without headings)? Then long enum with short descriptions will not take up more space in height?

@YuriSizov
Copy link
Contributor Author

YuriSizov commented Dec 2, 2021

That won't be very usable for long descriptions, namely because the width of the content is somewhat fixed. Plus, some enums are a mix of both cases, and in-betweens too.

PS. We are looking into improving the workflow for these help pages. Something that would help with them being stretched vertically (which is a problem as is).

@akien-mga akien-mga merged commit aaabc0a into godotengine:master Dec 3, 2021
@akien-mga
Copy link
Member

Thanks!

@YuriSizov YuriSizov deleted the docs-sort-group-newline-theme-and-enums branch December 6, 2021 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants