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

Make Transform2D/3D, Basis, and Quaternion docs more consistent #99650

Conversation

Mickeon
Copy link
Contributor

@Mickeon Mickeon commented Nov 24, 2024

Fixes #90727

This PR aims to be the glue that holds the following together:

It's an assortment of general tweaks and fixes for consistency between all 4 class reference pages, based off of prior reviews.

For people reading this, you may use this opportunity to point out oddities between all 4 so that they can be polished together.

doc/classes/Basis.xml Outdated Show resolved Hide resolved
@fire fire requested review from a team November 24, 2024 20:19
@Mickeon Mickeon force-pushed the documentation-transform-basis-quaternion-consistency branch from 296a30d to a3c913b Compare November 25, 2024 16:27
@Mickeon Mickeon marked this pull request as ready for review November 25, 2024 16:27
@Mickeon Mickeon requested a review from a team as a code owner November 25, 2024 16:27
doc/classes/Transform3D.xml Outdated Show resolved Hide resolved
doc/classes/Transform3D.xml Outdated Show resolved Hide resolved
@Mickeon Mickeon force-pushed the documentation-transform-basis-quaternion-consistency branch from a3c913b to d7ded61 Compare November 25, 2024 16:41
doc/classes/Basis.xml Outdated Show resolved Hide resolved
doc/classes/Basis.xml Show resolved Hide resolved
@Mickeon Mickeon force-pushed the documentation-transform-basis-quaternion-consistency branch from d7ded61 to 1f12fed Compare November 26, 2024 16:50
@Mickeon Mickeon requested a review from aaronfranke November 26, 2024 16:52
@Mickeon Mickeon force-pushed the documentation-transform-basis-quaternion-consistency branch from 1f12fed to 8878cab Compare November 26, 2024 22:44
@Mickeon
Copy link
Contributor Author

Mickeon commented Nov 26, 2024

I updated the PR with the above feedback, plus a few other minor tweaks to iron it out. This includes removing periods from # Prints comments. Almost all the time they're not present in these kinds of comments to only tell what is exactly printed to the console.

@Mickeon Mickeon force-pushed the documentation-transform-basis-quaternion-consistency branch from 8878cab to 6e58d6b Compare November 26, 2024 23:45
Copy link
Member

@aaronfranke aaronfranke 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.

@Mickeon Mickeon requested a review from tetrapod00 November 27, 2024 08:24
doc/classes/Basis.xml Outdated Show resolved Hide resolved
doc/classes/Basis.xml Outdated Show resolved Hide resolved
doc/classes/Transform2D.xml Outdated Show resolved Hide resolved
doc/classes/Transform3D.xml Outdated Show resolved Hide resolved
doc/classes/Transform3D.xml Outdated Show resolved Hide resolved
doc/classes/Basis.xml Outdated Show resolved Hide resolved
doc/classes/Transform2D.xml Outdated Show resolved Hide resolved
doc/classes/Transform3D.xml Outdated Show resolved Hide resolved
@Mickeon Mickeon force-pushed the documentation-transform-basis-quaternion-consistency branch from 6e58d6b to a4bf7fd Compare November 27, 2024 12:04
Copy link
Contributor

@tetrapod00 tetrapod00 left a comment

Choose a reason for hiding this comment

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

For general clarity, within the changes already made. I didn't read through all four classes to find potential new changes.

@akien-mga akien-mga modified the milestones: 4.x, 4.4 Nov 28, 2024
@Mickeon Mickeon force-pushed the documentation-transform-basis-quaternion-consistency branch from a4bf7fd to aa84e0c Compare November 29, 2024 14:12
doc/classes/Transform3D.xml Outdated Show resolved Hide resolved
@Mickeon Mickeon force-pushed the documentation-transform-basis-quaternion-consistency branch from aa84e0c to 82bd7db Compare November 29, 2024 15:11
Copy link
Member

@kleonc kleonc left a comment

Choose a reason for hiding this comment

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

No more nitpicks. 🎉

@Mickeon
Copy link
Contributor Author

Mickeon commented Nov 29, 2024

Nitpicks are what my neurodivergent perfectionism thrives for

@akien-mga akien-mga merged commit ba48849 into godotengine:master Nov 29, 2024
20 checks passed
@akien-mga
Copy link
Member

Thanks!

@Mickeon Mickeon deleted the documentation-transform-basis-quaternion-consistency branch November 29, 2024 21:15
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.

Non-uniform scaled basis returns wrong euler angles
7 participants