Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add ID as abbreviation for identification to style guide #2326

Open
oraNod opened this issue Jan 7, 2025 · 0 comments · May be fixed by #2332
Open

Add ID as abbreviation for identification to style guide #2326

oraNod opened this issue Jan 7, 2025 · 0 comments · May be fixed by #2332
Labels
good first issue Good for newcomers needs_triage Needs a first human triage before being processed.

Comments

@oraNod
Copy link
Contributor

oraNod commented Jan 7, 2025

Add an entry for ID as an abbreviation for identification or identifier to the Style Guide: https://docs.ansible.com/ansible/devel/dev_guide/style_guide/

From chat it can be confusing why it's ID and not camelcase Id or lowercase id.
@oraNod oraNod added the good first issue Good for newcomers label Jan 7, 2025
@ansible-documentation-bot ansible-documentation-bot bot added the needs_triage Needs a first human triage before being processed. label Jan 7, 2025
ganeshhubale added a commit to ganeshhubale/ansible-documentation that referenced this issue Jan 7, 2025
@ganeshhubale
fix(style-guide): Add definition for "ID" abbreviation in spelling an…
0571fb3 
…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: ansible#2326

Signed-off-by: Ganesh Hubale <[email protected]>
@ganeshhubale ganeshhubale linked a pull request Jan 7, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers needs_triage Needs a first human triage before being processed.
Projects
Ansible Documentation
Status: 🆕 Triage
Milestone
No milestone
1 participant
@oraNod