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

Standardize usage of compound words, and document standards in docs style guide #10218

Open
tetrapod00 opened this issue Nov 6, 2024 · 0 comments

Comments

@tetrapod00
Copy link
Contributor

tetrapod00 commented Nov 6, 2024

Your Godot version:
4.4
Issue description:
There are some compound words, like "antialiasing", that appear in the docs in both hyphenated form "anti-aliasing" and in single-word form "antialiasing". For consistent style, we should choose one form and standardize.

Some examples:

  • antialiasing / anti-aliasing
  • runtime / run-time
  • screen space / screen-space
  • builtin / built-in / built in (this one depends on context)

This is a fairly low priority issue. We should not break translations just to change this. However, we should choose which form to use for each compound word, document that choice in the style guide, and change existing usages whenever other changes are being made.

There's also precedent in #3502, #6978 of applying changes like this all at once.

URL to the documentation page (if already existing):
The whole manual and class reference.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant