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

Fix operator documentation in GDExtension API dump with docs #86087

Merged

Conversation

rburing
Copy link
Member

@rburing rburing commented Dec 12, 2023

This fixes the bug where some binary operators had a description which was actually from a different binary operator with the same name but a different right operand type. Now we check the right operand type when searching for the docs of binary operators.

In particular, this also removes the description from some (intentionally) undocumented operators like == and != where the right operand is a Variant, and % where the left operand is String and the right operand is not a Variant.

The type of the right operand is now taken into account.
@akien-mga akien-mga added the cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release label Dec 12, 2023
@akien-mga akien-mga merged commit 45b97ca into godotengine:master Dec 13, 2023
15 checks passed
@akien-mga
Copy link
Member

Thanks!

@rburing rburing deleted the fix_gdextension_operator_doc_dump branch December 13, 2023 10:27
@YuriSizov YuriSizov removed the cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release label Jan 25, 2024
@YuriSizov
Copy link
Contributor

Cherry-picked for 4.2.2.

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.

--dump-extension-api-with-docs produces incorrect documentation for some data types
3 participants