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

Move the docs for constructors and operators out of methods section #53452

Merged
merged 1 commit into from
Oct 31, 2021

Conversation

aaronfranke
Copy link
Member

I'm interested in improving the documentation for operators, but before I do, I think it would be a significant improvement to separate operators from regular methods. We may as well do this with constructors too. Constructors and operators are very different from regular methods, so it makes sense that they should be separate.

I'm not very familiar with this code. This PR has not been thoroughly tested, there's likely things missing, and it's likely that the code can be simplified to not have so much duplication (would involve a fair amount of refactoring though). I assume there will also need to be updates for the docs repo so that it can read these new sections (I haven't touched the Python scripts). If anyone more knowledgeable can fix any remaining issues with this, feel free to use this PR as a base.

Anyway, the basics do work. Here is an example of how Color shows up in the editor. Previously everything was all together in one "Methods" section. Now constructors and operators get their own categories.

color-classref

The descriptions work too, here's the "Operator Descriptions" section (they do work, but these ones have no description).

color-classref-2

Here's what it looks like in the XML files, there are now sections for constructors and operators:

color-classref-3

Copy link
Member

@mhilbrunner mhilbrunner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like a good improvement to me.
If we do this, we should do the same for the online docs.

@YuriSizov
Copy link
Contributor

If we do this, we should do the same for the online docs.

In fact, I think after this PR syncing will remove all those moved items from the online docs. But I think it's okay to update makerst.py in a separate PR. Should be pretty trivial.

@akien-mga
Copy link
Member

Needs rebase.

@akien-mga akien-mga merged commit 1dd7427 into godotengine:master Oct 31, 2021
@akien-mga
Copy link
Member

Thanks!

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.

4 participants