Skip to content

Commit 11b8d55

Browse files
authored
update: clarify acronym capitalization rules in declaration names (#4678)
* update: removing ambiguity from capitalization rules * implementing review suggestion
1 parent 36a8aad commit 11b8d55

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/topics/coding-conventions.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,8 +229,10 @@ sorting a collection in place, while `sorted` is returning a sorted copy of the
229229
The names should make it clear what the purpose of the entity is, so it's best to avoid using meaningless words
230230
(`Manager`, `Wrapper`) in names.
231231

232-
When using an acronym as part of a declaration name, capitalize it if it consists of two letters (`IOStream`);
233-
capitalize only the first letter if it is longer (`XmlFormatter`, `HttpInputStream`).
232+
When using an acronym as part of a declaration name, follow these rules:
233+
234+
* For two-letter acronyms, use uppercase for both letters. For example, `IOStream`.
235+
* For acronyms longer than two letters, capitalize only the first letter. For example, `XmlFormatter` or `HttpInputStream`.
234236

235237
## Formatting
236238

0 commit comments

Comments
 (0)