Skip to content

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

Open
@tetrapod00

Description

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)
  • subsurface / sub-surface
  • subemitter / sub-emitter
  • standalone / stand-alone
  • low-level / low level
  • high-level / high level
  • low-end / low end
  • addon / add-on (this one shows up in editor UI and in the res://addons/ folder, too!)

Resolved and standardized (within the manual):

  • Use "antialiasing", not "anti-aliasing". Added to codespell dictionary.
  • Use "runtime", not "run-time". In specific cases, "run time" is okay.
  • Use "built-in" as an adjective or noun, "built into" as a phrase. Avoid "built in" or "builtin", and avoid "built-in to".
  • Use "low-level", "low-end", "high-level", "high-end" as adjectives.

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.

Activity

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

Metadata

Assignees

No one assigned

    Labels

    area:aboutIssues and PRs related to the About section of the documentation and other general articlesarea:contributingIssues and PRs related to the Contributing/Development section of the documentationarea:manualIssues and PRs related to the Manual/Tutorials section of the documentationcontent:proofreadingIssues and PRs related to proofreading the documentationenhancement

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions