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 warnings in class ref #68848

Merged
merged 1 commit into from
Nov 22, 2022
Merged

Conversation

Piralein
Copy link
Member

@Piralein Piralein commented Nov 18, 2022

Fix: WARNING: Could not lex literal_block as "csharp". Highlighting skipped
(invalid comment character # instead of //)

Fix: WARNING: undefined label: class_popup_property_popup_window
the referenced member needs to reference the parent class

Fix: WARNING: undefined label: class_basis_operator_mul_vector3, ...
Operators with the same name didn't create the class ref in the operator description section.

This fix results in: WARNING: Duplicate explicit target name
Operators can have the same name and return type, which are used to create the ref identifier, resulting in duplicates.
example: class_float with vector2 and vector2i both returning vector2

This change will instead include parameter types and not return types in the identifier, but this can break external links to the operator description.
Internal should all be updated by this change. (I hope...)

doc/tools/make_rst.py Outdated Show resolved Hide resolved
doc/tools/make_rst.py Outdated Show resolved Hide resolved
doc/tools/make_rst.py Outdated Show resolved Hide resolved
doc/tools/make_rst.py Outdated Show resolved Hide resolved
@Piralein Piralein marked this pull request as ready for review November 20, 2022 13:06
@Piralein Piralein requested a review from a team as a code owner November 20, 2022 13:06
@akien-mga
Copy link
Member

Looks good! Could you squash the commits? See PR workflow for instructions.

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.

LGTM, haven't tested the make_rst.py changes though

Copy link
Contributor

@YuriSizov YuriSizov left a comment

Choose a reason for hiding this comment

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

Tried it locally and the resulting diff for RST files looks correct.

@YuriSizov YuriSizov merged commit 0aba659 into godotengine:master Nov 22, 2022
@YuriSizov
Copy link
Contributor

Thanks!

@Piralein Piralein deleted the fix-class-ref branch November 22, 2022 17:56
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