-
-
Notifications
You must be signed in to change notification settings - Fork 21.1k
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
akien-mga
merged 1 commit into
godotengine:master
from
Mickeon:doc-peeves-basis-examples
Jan 3, 2024
Merged
Add code examples to Basis' documentation #86664
akien-mga
merged 1 commit into
godotengine:master
from
Mickeon:doc-peeves-basis-examples
Jan 3, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mickeon
force-pushed
the
doc-peeves-basis-examples
branch
from
December 31, 2023 12:20
376bc84
to
4523ec2
Compare
fire
reviewed
Dec 31, 2023
aaronfranke
reviewed
Jan 1, 2024
aaronfranke
reviewed
Jan 1, 2024
Mickeon
force-pushed
the
doc-peeves-basis-examples
branch
from
January 1, 2024 11:08
4523ec2
to
032daa5
Compare
Addressed the above feedback. Also replaced every PI example with TAU. |
aaronfranke
reviewed
Jan 1, 2024
Mickeon
force-pushed
the
doc-peeves-basis-examples
branch
from
January 1, 2024 18:32
032daa5
to
e88a819
Compare
aaronfranke
approved these changes
Jan 1, 2024
fire
approved these changes
Jan 1, 2024
akien-mga
changed the title
Add code examples to Basis' Documentation
Add code examples to Basis' documentation
Jan 2, 2024
Would be good to add the C# counterparts, CC @godotengine/dotnet. |
I can make a follow-up PR after this is merged. |
Thanks! |
Aww, the triple. |
paulloz
added a commit
to paulloz/godot
that referenced
this pull request
Jan 3, 2024
Follow up to godotengine#86664
GuybrushThreepwood-GitHub
pushed a commit
to GuybrushThreepwood-GitHub/godot
that referenced
this pull request
Jan 27, 2024
Follow up to godotengine#86664
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.