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 TODO comments in class reference #99242

Merged
merged 1 commit into from
Jan 3, 2025

Conversation

RedMser
Copy link
Contributor

@RedMser RedMser commented Nov 14, 2024

Fixes #65576
(I suggest closing the tracker issue, so that future TODOs don't end up as remarks in the text, but instead as issues on the repository)

  • RenderingServer.viewport_attach_to_screen docs were confused about why the method does not exist on Viewport. I just rewrote the code sample to use the API itself, and verified that it still does exactly what the description above is describing.
  • SurfaceTool.commit docs did not understand the flags parameter. Since the custom format flags seem to be filled automatically, only the compress flags can be specified. I took the possible values from ArrayMesh.add_surface_from_arrays, even though this only lists some of the compress flags and not a full exhaustive list. I assume there's good reason for this, but maybe not?
  • While touching RenderingServer docs, I took the liberty of documenting duplicate enum values that are already documented in the Mesh class.

@RedMser RedMser requested a review from a team as a code owner November 14, 2024 18:56
@Mickeon Mickeon added this to the 4.4 milestone Nov 14, 2024
@Mickeon Mickeon requested review from Mickeon and a team November 14, 2024 19:24
@Mickeon Mickeon added cherrypick:4.1 cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release cherrypick:4.3 Considered for cherry-picking into a future 4.3.x release labels Nov 14, 2024
Copy link
Contributor

@Mickeon Mickeon left a comment

Choose a reason for hiding this comment

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

Approving on the content of it, but the rendering team needs to take a look.
Note that, indeed, the descriptions of these constants are duplicates of existing ones. Any suggestions for them should also apply to the originals, hence I'm not proposing changes to them here.

@RedMser RedMser force-pushed the fix-todos-in-classref branch from 4cab746 to 30a573e Compare November 14, 2024 19:42
@akien-mga akien-mga added cherrypick:4.3 Considered for cherry-picking into a future 4.3.x release and removed cherrypick:4.3 Considered for cherry-picking into a future 4.3.x release cherrypick:4.1 labels Jan 2, 2025
@akien-mga akien-mga merged commit 7ccc00d into godotengine:master Jan 3, 2025
20 checks passed
@akien-mga
Copy link
Member

Thanks!

@akien-mga akien-mga removed the cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release label Mar 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug cherrypick:4.3 Considered for cherry-picking into a future 4.3.x release documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[TRACKER] TODOs in class documentation
3 participants