mirror of
https://github.com/ansible/ansible-documentation.git
synced 2026-03-27 13:28:51 +07:00
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: ansible/ansible-documentation#2326 Signed-off-by: Ganesh Hubale <ganeshhubale03@gmail.com>
This commit is contained in:
@@ -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."
|
||||
|
||||
Reference in New Issue
Block a user