From cf2793c88de93a155c5a77aca65dc6541c066c76 Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Fri, 10 Jan 2025 14:58:54 -0500 Subject: [PATCH] fix(style-guide): Add definition for "ID" abbreviation in spelling and word choice guide (#2332) (#2336) - 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 (cherry picked from commit 8e331e4b16e5acb45322ab01bf5a97a2a7b02097) Co-authored-by: Ganesh Hubale --- .../rst/dev_guide/style_guide/spelling_word_choice.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/docsite/rst/dev_guide/style_guide/spelling_word_choice.rst b/docs/docsite/rst/dev_guide/style_guide/spelling_word_choice.rst index efddb929e7b..bad1f5c7003 100644 --- a/docs/docsite/rst/dev_guide/style_guide/spelling_word_choice.rst +++ b/docs/docsite/rst/dev_guide/style_guide/spelling_word_choice.rst @@ -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."