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

Improve VisibleOnScreen classes' docs #81774

Merged

Conversation

MewPurPur
Copy link
Contributor

These docs were super old and had some misleading information, unless I've misunderstood something. Some bad English too. And a few descriptions were missing.

I tested to reaffirm that I'm not getting things wrong, but I'm not a big user of these classes so I might have missed some peculiarity or something.

@MewPurPur MewPurPur requested a review from a team as a code owner September 16, 2023 22:29
@MewPurPur MewPurPur force-pushed the improve-visible-on-screen-class-docs branch from 7addb06 to 21cf8d3 Compare September 16, 2023 22:35
@Calinou Calinou added enhancement documentation cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release labels Sep 16, 2023
@Calinou
Copy link
Member

Calinou commented Sep 16, 2023

cc @mrjustaguy, as they worked with this class previously.

@Calinou Calinou added this to the 4.2 milestone Sep 16, 2023
doc/classes/VisibleOnScreenEnabler2D.xml Outdated Show resolved Hide resolved
doc/classes/VisibleOnScreenEnabler3D.xml Outdated Show resolved Hide resolved
doc/classes/VisibleOnScreenEnabler3D.xml Outdated Show resolved Hide resolved
doc/classes/VisibleOnScreenNotifier3D.xml Outdated Show resolved Hide resolved
@MewPurPur MewPurPur force-pushed the improve-visible-on-screen-class-docs branch 5 times, most recently from 22815f8 to dc669a2 Compare September 17, 2023 16:28
Copy link
Contributor

@mrjustaguy mrjustaguy left a comment

Choose a reason for hiding this comment

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

Looks good to me

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.

Aside from the note that I have left, looks solid to me.

@MewPurPur MewPurPur force-pushed the improve-visible-on-screen-class-docs branch from dc669a2 to 53d0ba2 Compare October 17, 2023 16:29
@akien-mga akien-mga merged commit 0181983 into godotengine:master Oct 17, 2023
15 checks passed
@akien-mga
Copy link
Member

Thanks!

@MewPurPur MewPurPur deleted the improve-visible-on-screen-class-docs branch October 17, 2023 22:47
@YuriSizov YuriSizov removed the cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release label Jan 23, 2024
@YuriSizov
Copy link
Contributor

If we want this in 4.1, it would make sense to create a separate PR that only adds missing descriptions. I'd avoid breaking translations in the fourth patch release.

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.

5 participants