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

Error in Godot 3D documentation #8904

Closed
Overhaul66 opened this issue Feb 4, 2024 · 6 comments
Closed

Error in Godot 3D documentation #8904

Overhaul66 opened this issue Feb 4, 2024 · 6 comments
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation bug

Comments

@Overhaul66
Copy link

Tested versions

Godot 4.2 documentation
Transform 3D was explained incorrectly

IMG-20240204-WA0016

IMG-20240204-WA0015

System information

Internet

Issue description

There was a mistake in explaining the matrix that transform3D represents

IMG-20240204-WA0016

A transform3D is supposed to be a 3x4 matrix

IMG-20240204-WA0015

Steps to reproduce

None

Minimal reproduction project (MRP)

None

@brcontainer
Copy link

I may be wrong, but I believe that the documentation is community, but separately, you should send corrections to the documentation as advised in:

https://docs.godotengine.org/en/latest/contributing/documentation/contributing_to_the_documentation.html

Related: https://github.com/godotengine/godot-docs

@Mickeon
Copy link
Contributor

Mickeon commented Feb 5, 2024

I may be wrong, but I believe that the documentation is community, but separately, you should send corrections to the documentation as advised in:

This is true, but the contents of the class reference are actually generated from this repository. So it's appropriate to report it here.

I can keep this in mind for godotengine/godot#87334

Edit: No wait. You are not specifying where this is being stated:
image
If it's part of the documentation outside of the class reference, this should be reported in https://github.com/godotengine/godot-docs

@Mickeon
Copy link
Contributor

Mickeon commented Feb 5, 2024

I found the "offending" paragraph

Node3D). This transform can be accessed as a 4×3
as part of the introduction to 3D. Yes, this issue should be moved to the other repository.

@Mickeon Mickeon transferred this issue from godotengine/godot Feb 5, 2024
@Mickeon Mickeon added bug good first issue area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Feb 5, 2024
@kleonc
Copy link
Member

kleonc commented Feb 5, 2024

Note it's not just the 4×3 part being wrong, the rest of the sentence and the image are outdated (edit: it's not the only image on that page which is outdated; probably the whole page needs rechecking/updating).
VeWEwh7G

It was changed in the meantime how Transform3D is exposed:
Vp0iiNIYBf

Skyefre added a commit to Skyefre/godot-docs that referenced this issue Apr 2, 2024
As pointed out in Issue godotengine#8904, a Transform3D is a 3x4 transformation matrix, not a 4x3. While that issue does point out other areas of concern on this specific page, this update is simply to fix that error. The change can be found on line 35.
Skyefre added a commit to Skyefre/godot-docs that referenced this issue Apr 4, 2024
As pointed out in Issue godotengine#8904, a Transform3D is a 3x4 transformation matrix, not a 4x3. While that issue does point out other areas of concern on this specific page, this update is simply to fix that error. The change can be found on line 35.
Skyefre added a commit to Skyefre/godot-docs that referenced this issue Apr 4, 2024
As pointed out in Issue godotengine#8904, a Transform3D is a 3x4 transformation matrix, not a 4x3. While that issue does point out other areas of concern on this specific page, this update is simply to fix that error. The change can be found on line 35.
@LunarTides
Copy link
Contributor

Shouldn't this be closed now that #9174 is merged?

@clayjohn
Copy link
Member

Yes.

Kleonc's comment is still outstanding, but I think this bug report can be closed as overhauling the 3D docs is a bit out of scope for this and is better tracked elsewhere (i.e. in the docs repo)

mhilbrunner pushed a commit that referenced this issue Jul 24, 2024
As pointed out in Issue #8904, a Transform3D is a 3x4 transformation matrix, not a 4x3. While that issue does point out other areas of concern on this specific page, this update is simply to fix that error. The change can be found on line 35.

(cherry picked from commit 9fdfe11)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation bug
Projects
None yet
Development

No branches or pull requests

7 participants