Skip to content

Commit c08b634

Browse files
committed
Write the Acronym Indeterminate Inputs section
1 parent 236eb5a commit c08b634

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

docs/for-contributors/Generator/name-processing.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,20 @@ handles pascal casing, which simply uppercases the first character and lowercase
183183

184184
#### Acronym Indeterminate Inputs
185185

186-
(TODO)
186+
These refer to inputs that are fully uppercased, making it hard to tell whether the input is a standalone acronym or
187+
simply written in screaming case.
188+
189+
The current code handling this behavior was implemented back when the generator used a default long acronym threshold of
190+
3 (and occasionally using 4*), which in turn was ported from the original Humanizer-based prettify implementation.
191+
Therefore, the examples given in the code state a threshold of 4.
192+
193+
\*4 was used for Khronos APIs as a best effort to preserve vendor suffixes (eg: `KHR`, `EXT`, `NV`, `QCOM`). This is no
194+
longer necessary because the name affix system is now used to preserve these suffixes.
195+
196+
This behavior notably is less noticeable with the long acronym threshold of 2, but still affects a few names, such as
197+
the `GL` class. Without this, `GL` gets turned into `Gl` since the input is treated as screaming case.
198+
199+
To learn more about this behavior, please refer to the comments in `NamePrettifier`.
187200

188201
#### Handling of Consecutive Acronyms
189202

0 commit comments

Comments
 (0)