litestar
litestar copied to clipboard
docs: Use the article "an" for words beginning with SQL
By submitting this pull request, I agree to:
- [x] follow Litestar's Code of Conduct;
- [x] follow Litestar's contribution guidelines;
- [x] follow the PSFs's Code of Conduct.
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.
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'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'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 ;)
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.
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/4042
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.