litestar icon indicating copy to clipboard operation
litestar copied to clipboard

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

Open eandersons opened this issue 8 months ago • 6 comments

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 avatar Mar 03 '25 15:03 eandersons

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 :)

euri10 avatar Mar 03 '25 16:03 euri10

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.

eandersons avatar Mar 04 '25 06:03 eandersons

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 ;)

euri10 avatar Mar 04 '25 06:03 euri10

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.

cofin avatar Mar 07 '25 21:03 cofin

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

github-actions[bot] avatar Mar 07 '25 21:03 github-actions[bot]

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.

provinzkraut avatar Mar 08 '25 12:03 provinzkraut