godot-docs icon indicating copy to clipboard operation
godot-docs copied to clipboard

Error in Godot 3D documentation

Open Overhaul66 opened this issue 1 year ago • 4 comments
trafficstars

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

Overhaul66 avatar Feb 04 '24 20:02 Overhaul66

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

brcontainer avatar Feb 05 '24 07:02 brcontainer

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 https://github.com/godotengine/godot/pull/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 avatar Feb 05 '24 13:02 Mickeon

I found the "offending" paragraph https://github.com/godotengine/godot-docs/blob/62d5d6cddbb2768976abea1cd3420b36ca492003/tutorials/3d/introduction_to_3d.rst#L35 as part of the introduction to 3D. Yes, this issue should be moved to the other repository.

Mickeon avatar Feb 05 '24 14:02 Mickeon

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

kleonc avatar Feb 05 '24 16:02 kleonc

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

LunarTides avatar Apr 30 '24 11:04 LunarTides

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)

clayjohn avatar Apr 30 '24 21:04 clayjohn