blender/blender-developer-docs
7
8
Fork 38
Code Issues 3 Pull Requests 6 Activity

Writing style: mention capitalization of "brand names" #79

Merged
Pablo Vazquez merged 2 commits from pioverfour/blender-developer-docs:dp_capitals_hig into main 2024-10-08 12:07:06 +02:00
Conversation 1 Commits 2 Files Changed 1 +6 -3
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/features/interface/human_interface_guidelines/writing_style.md
View File

@ -11,6 +11,11 @@
- Not capitalizing entity names is an arguable guideline, but avoids
many fuzzy cases.
- Brand / product names such as *Cycles*, *Grease Pencil*, *Line Art*, *Freestyle*
Pablo Vazquez commented 2024-10-08 11:23:10 +02:00
Review
Copy Link

Maybe mention that EEVEE is always capitalized as well.

Maybe mention that EEVEE is always capitalized as well.
👍 1
are always capitalized. EEVEE is always uppercase.
- “Channel” identifiers, like _X_, _Y_, _Z_, _R_, _G_, _B_, etc. are always capitalized.
- Do <u>not</u> use abbreviations like _verts_, _VGroups_, _loc_, or _rot_,
_fac_. Instead, use plain words like _vertices_, _vertex groups_,
_location_, _rotation_, _factor_.
@ -20,15 +25,13 @@
much longer, and it helps keeping consistent styling over the whole
UI.
- “Channel” identifiers, like _X_, _Y_, _Z_, _R_, _G_, _B_, etc. are always capitalized.
- Do <u>not</u> use implementation specific language.
!!! Example "Examples"
- Instead of _ID_, use _data-block_.
- Do <u>not</u> use terms like _flag_, _string_, _RNA_, _DNA_.
- Don't use pronouns, such as _you_. This sounds like an accusation towards the user.<br/>
- Do not use pronouns, such as _you_. This sounds like an accusation towards the user.<br/>
!!! Example
**Don't**: _Your mesh is very dense_<br/>