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

Add code examples to Basis' documentation #86664

Merged
merged 1 commit into from
Jan 3, 2024

Conversation

Mickeon
Copy link
Contributor

@Mickeon Mickeon commented Dec 31, 2023

This PR attempts to add code examples to the Basis Variant type, which really needs some more detailing.

More knowledgeable users may already know what a Basis is and it feels like this class reference is written for them. For an introduction to the concept, this page is extremely dry, and it makes things look more complicated than they are in practice. I am also talking from personal experience here.

The original intention was to overhaul the Basis class reference outright, but I was keen on splitting the PR in two. This is because I am not sure what would be a... good enough way to do this, and concentrated feedback from more "savvy" users and maintainers is very welcome here.

In particular, it would be nice to find a way to represent the Basis matrix in the examples in a way that doesn't look out of place or overly verbose.

One problem:
Each so-called matrix "column" is a Vector3, which when written tidily, forces the code examples to display them horizontally rather than vertically. It may confusing.

doc/classes/Basis.xml Outdated Show resolved Hide resolved
doc/classes/Basis.xml Outdated Show resolved Hide resolved
doc/classes/Basis.xml Outdated Show resolved Hide resolved
doc/classes/Basis.xml Outdated Show resolved Hide resolved
@Mickeon
Copy link
Contributor Author

Mickeon commented Jan 1, 2024

Addressed the above feedback. Also replaced every PI example with TAU.

doc/classes/Basis.xml Outdated Show resolved Hide resolved
@akien-mga akien-mga changed the title Add code examples to Basis' Documentation Add code examples to Basis' documentation Jan 2, 2024
@akien-mga
Copy link
Member

Would be good to add the C# counterparts, CC @godotengine/dotnet.

@paulloz
Copy link
Member

paulloz commented Jan 3, 2024

Would be good to add the C# counterparts, CC @godotengine/dotnet.

I can make a follow-up PR after this is merged.

@akien-mga akien-mga modified the milestones: 4.x, 4.3 Jan 3, 2024
@akien-mga akien-mga merged commit f38076e into godotengine:master Jan 3, 2024
15 checks passed
@akien-mga
Copy link
Member

Thanks!

@Mickeon
Copy link
Contributor Author

Mickeon commented Jan 3, 2024

Aww, the triple.

@Mickeon Mickeon deleted the doc-peeves-basis-examples branch January 3, 2024 09:43
paulloz added a commit to paulloz/godot that referenced this pull request Jan 3, 2024
GuybrushThreepwood-GitHub pushed a commit to GuybrushThreepwood-GitHub/godot that referenced this pull request Jan 27, 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.

6 participants