Skip to content

docs: Use the article "an" for words beginning with SQL #4042

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

eandersons
Copy link
Contributor

@eandersons eandersons commented Mar 3, 2025

By submitting this pull request, I agree to:

Description

Article "a" was replaced with "an" for words beginning with "SQL" as the pronunciation of SQL starts with a vowel sound: /ˌɛsˌkjuˈɛl/ (S-Q-L). Previously both "a SQL*" and "an SQL*" were used.
That is, if project authors do not prefer the alternative pronunciation /ˈsiːkwəl/ ("sequel"), in which case the existing occurrences of "an SQL*" should be replaced with "a SQL*".

For reference:

Closes

Not applicable.

@eandersons eandersons requested review from a team as code owners March 3, 2025 15:56
@github-actions github-actions bot added area/docs This PR involves changes to the documentation size: small type/docs pr/external Triage Required 🏥 This requires triage labels Mar 3, 2025
@euri10
Copy link
Contributor

euri10 commented Mar 3, 2025

I'd rather debate on vim/emacs but well you mentionned /ˈsiːkwəl/ "sequel" so I'd rather see it the other way around, but no hard feelings on this, I'll let maintainers maintain which pronouciation they think is appropriate :)

@eandersons
Copy link
Contributor Author

I'd rather debate on vim/emacs but well you mentionned /ˈsiːkwəl/ "sequel" so I'd rather see it the other way around, but no hard feelings on this, I'll let maintainers maintain which pronouciation they think is appropriate :)

I am not trying to start a flame war. I noticed that both "a" and "an" were used with "SQL*" and I subjectively objectively chose the right one.
This pull request is not about which pronunciation of "SQL" is the correct one, but to point to inconsistencies with article used with "SQL*". In the end it is up to project authors/maintainers to decide which article should be used with "SQL*" in project's documentation.

@euri10
Copy link
Contributor

euri10 commented Mar 4, 2025

I'd rather debate on vim/emacs but well you mentionned /ˈsiːkwəl/ "sequel" so I'd rather see it the other way around, but no hard feelings on this, I'll let maintainers maintain which pronouciation they think is appropriate :)

I am not trying to start a flame war. I noticed that both "a" and "an" were used with "SQL*" and I subjectively objectively chose the right one. This pull request is not about which pronunciation of "SQL" is the correct one, but to point to inconsistencies with article used with "SQL*". In the end it is up to project authors/maintainers to decide which article should be used with "SQL*" in project's documentation.

I was joking @eandersons ! And I agree with you with the consistency part while I disagree on the pronouciation ;)

Article "a" was replaced with "an" for words beginning with "SQL" as the
pronunciation starts with a vowel sound: /ˌɛsˌkjuˈɛl/ (S-Q-L; that is,
if project authors do not prefer the alternative pronunciation
/ˈsiːkwəl/ ("sequel")).

For reference:

- https://www.scribbr.com/commonly-confused-words/a-vs-an/#acronyms
- https://en.wikipedia.org/wiki/SQL
@cofin
Copy link
Member

cofin commented Mar 7, 2025

I would prefer to use the a article for SQL. I generally pronounce the SQLAlchemy library similarly to "sequel alchemy".

In fact, I almost never treat "SQL" as an initialism. It's always used as an acronym.

I definitely agree that it should be consistent though.

Copy link

github-actions bot commented Mar 7, 2025

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/4042

@provinzkraut
Copy link
Member

I'll defer to @cofin on this, as I personally do not care which way we're going, but I agree that consistency is a good thing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs This PR involves changes to the documentation pr/external pr/internal size: small Triage Required 🏥 This requires triage type/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants