Skip to content

Commit

Permalink
fix(style-guide): Add definition for "ID" abbreviation in spelling an…
Browse files Browse the repository at this point in the history
…d word choice guide

- 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]>
  • Loading branch information
ganeshhubale committed Jan 7, 2025
1 parent 07c85f9 commit 0571fb3
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/docsite/rst/dev_guide/style_guide/spelling_word_choice.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,16 @@ Hostname
^^^^^^^^
Correct. Do not use host name.

ID
^^
Use **ID** (all uppercase) when referring to "Identification" or "Identifier."

- Do not use "Id," "id," or other variations.
- Examples:
- "User ID"
- "Resource ID"
- **Reason**: "ID" is a standard abbreviation for "Identification" or "Identifier" and is more readable when capitalized consistently.

i.e.
^^^^
Spell it out: "That is."
Expand Down

0 comments on commit 0571fb3

Please sign in to comment.