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 a property reference in EditorSpinSlider documentation #84709

Merged

Conversation

YuriSizov
Copy link
Contributor

A regression from one of the recent changes. Basically, we don't seem to validate at any point if a class member referenced in the class documentation is local or inherited but overridden. When it's an overridden reference, the link should be done to the owning class, but all our checks seem to be satisfied with an empty overrides record:

<member name="step" type="float" setter="set_step" getter="get_step" overrides="Range" default="1.0" />

This breaks when building online docs, however, since overridden properties do not generate any sections in the class reference and so don't generate links.

/home/yuris/projects/godot-docs/classes/class_editorspinslider.rst:24: WARNING: undefined label: class_editorspinslider_property_step                                                                      
/home/yuris/projects/godot-docs/classes/class_editorspinslider.rst:24: WARNING: undefined label: class_editorspinslider_property_step

Surprising that this is a rare issue. Ideally I'd want to fix the validation, but I'll have to do this later. Fixing the docs themselves for now should be enough.

@YuriSizov YuriSizov added this to the 4.2 milestone Nov 10, 2023
@YuriSizov YuriSizov requested a review from a team as a code owner November 10, 2023 11:48
@YuriSizov YuriSizov force-pushed the docs-fix-overridden-reference branch from 8f9965e to d9c980f Compare November 10, 2023 14:30
@YuriSizov YuriSizov changed the title Fix a property reference in EditorSpinSlider Fix a property reference in EditorSpinSlider documentation Nov 10, 2023
@akien-mga akien-mga merged commit a6807f8 into godotengine:master Nov 10, 2023
15 checks passed
@akien-mga
Copy link
Member

Thanks!

@YuriSizov YuriSizov deleted the docs-fix-overridden-reference branch November 10, 2023 15:03
@mhilbrunner
Copy link
Member

This was originally changed here and cherry-picked into 4.1 here, so this fix needs to be cherry-picked to 4.1 as well.

@mhilbrunner mhilbrunner added the cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release label May 7, 2024
@akien-mga
Copy link
Member

Cherry-picked for 4.1.5.

@akien-mga akien-mga removed the cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release label May 7, 2024
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