Skip to content

Commit 8e331e4

Browse files
authored
fix(style-guide): Add definition for "ID" abbreviation in spelling and word choice guide (#2332)
- Added entry for "ID" (Identification/Identifier) to the spelling and word choice guide. - Clarified correct usage as "ID" (all uppercase) and specified avoiding variations like "Id" or "id". - Provided examples and reasoning for consistent capitalization. Resolves: #2326 Signed-off-by: Ganesh Hubale <[email protected]>
1 parent 07c85f9 commit 8e331e4

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/docsite/rst/dev_guide/style_guide/spelling_word_choice.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,16 @@ Hostname
145145
^^^^^^^^
146146
Correct. Do not use host name.
147147

148+
ID
149+
^^
150+
Use **ID** (all uppercase) when referring to "Identification" or "Identifier."
151+
152+
- Do not use "Id," "id," or other variations.
153+
- Examples:
154+
- "User ID"
155+
- "Resource ID"
156+
- **Reason**: "ID" is a standard abbreviation for "Identification" or "Identifier" and is more readable when capitalized consistently.
157+
148158
i.e.
149159
^^^^
150160
Spell it out: "That is."

0 commit comments

Comments
 (0)