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

Capitalization of "GLTF" and "glTF" is not standardized across class reference and manual. #9750

Closed
tetrapod00 opened this issue Aug 15, 2024 · 1 comment · Fixed by godotengine/godot#95578 or #9754
Labels
area:class reference Issues and PRs about the class reference, which should be addressed on the Godot engine repository area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement topic:import

Comments

@tetrapod00
Copy link
Contributor

tetrapod00 commented Aug 15, 2024

Your Godot version:
4.3
Issue description:
The docs have no standardization of capitalization for the glTF format (and meshes or files of that format). Both "GLTF" and "glTF" appear throughout the manual and class reference. This page even uses both.

Official usage from the glTF specs page:

  • "glTF" for the format.
  • "GLB" for a binary file.
  • ".gltf" for the format extension.

Godot classes use all-caps GTLF, as in GLTFAccessor. This makes sense for class naming rules. All other uses should ideally be standardized to the official style of "glTF".

Standardizing this would involve a lot of churn in the class reference, so perhaps this should be a style guideline that is applied whenever a file is already being changed.

URL to the documentation page (if already existing):
https://docs.godotengine.org/en/4.3/classes/class_gltfaccessor.html
https://docs.godotengine.org/en/latest/classes/class_gltfstate.html
https://docs.godotengine.org/en/latest/search.html?q=gltf

@tetrapod00 tetrapod00 changed the title Styling of "GLTF" and "glTF" is not standardized across class reference and manual. Capitalization of "GLTF" and "glTF" is not standardized across class reference and manual. Aug 15, 2024
@skyace65 skyace65 reopened this Aug 16, 2024
@skyace65
Copy link
Contributor

Once the class reference PR is merged this can be closed.

@skyace65 skyace65 added area:class reference Issues and PRs about the class reference, which should be addressed on the Godot engine repository area:manual Issues and PRs related to the Manual/Tutorials section of the documentation topic:import labels Aug 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:class reference Issues and PRs about the class reference, which should be addressed on the Godot engine repository area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement topic:import
Projects
None yet
2 participants