Skip to content

Fixed typos in docblocks. #638

Closed
wants to merge 3 commits into from

6 participants

@dustinmoorman

Hello again, I'm committing the mini fixes in docblock documentation - swapping 'an SQL' for 'a SQL'.

Thanks!

@doctrinebot

Hello,

thank you for positing this Pull Request. I have automatically opened an issue on our Jira Bug Tracker for you with the details of this Pull-Request. See the Link:

http://doctrine-project.org/jira/browse/DDC-2380

@beberlei
Doctrine member

This is not a typo in my opinion, SQL is pronunced esquel, making the "an" correct. The same is done on the wikipedia page for SQL, http://en.wikipedia.org/wiki/SQL

@dustinmoorman

Right, but given the various interpretations, be it 'es-cue-el' or 'sequel', the literal representation of the acronym is 'Structured Query Language'. So what you're saying in documentation is:

"..returns an Structured Query Language result."

Which is incorrect.

@guilhermeblanco
Doctrine member

I tend to agree with acronym "Structured Query Language". It should be "a".

@Ocramius
Doctrine member

First of all, I don't have strong opinions on the suggestion.

Please consider that an acronym doesn't read like the real thing. We explicitly use acronyms to avoid reading the real thing.

@jaydiablo

It seems generally accepted that you choose a or an based on how the following acronym reads, not necessarily how what it stands for reads (though that is done as well, but much less common).

Which then raises the question, how is SQL read? That also varies. I think the project just needs to pick one and be consistent.

A decent discussion with other references that basically comes to the same conclusion:

http://english.stackexchange.com/questions/1016/do-you-use-a-or-an-before-acronyms

@beberlei
Doctrine member
beberlei commented Apr 1, 2013

Rejected and following the wikipedia pronunciation here. "a" or "an" is not about resolving the acronym, its about speach, not writing. "an" sounds much more fluent. Its also not "a hour", but "an hour".

Decision was made after much twitter feedback on the question: https://twitter.com/beberlei/status/318836336910024705

@beberlei beberlei closed this Apr 1, 2013
@dustinmoorman

Thanks for the clarification guys!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.