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.

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

RwLock Typo #21440

Closed
Jojoshua opened this issue Jan 20, 2015 · 6 comments · Fixed by #21477
Closed

RwLock Typo #21440

Jojoshua opened this issue Jan 20, 2015 · 6 comments · Fixed by #21477

Comments

@Jojoshua
Copy link

fn new(t: T) -> RwLock

Creates a new instance of an RwLock which is unlocked and read to go.
->
Creates a new instance of a RwLock which is unlocked and ready to go.

@Diggsey
Copy link
Contributor

Diggsey commented Jan 21, 2015

Depends how you pronounce RwLock, (I'm assuming the writer pronounced it "Are-Double-You-Lock")

@sfackler
Copy link
Member

I read it as "are double yoo lock" so the current version seems fine.

@steveklabnik
Copy link
Member

Yeah, I do too. Interesting...

@tomjakubowski
Copy link
Contributor

RwLock comes from the compound noun "RW lock", composed of the initialism "RW" (for readers-writer) and the noun "lock," which is turned into a struct name per Rust's naming conventions.

Initialisms are pronounced by reading each letter out left-to-right so the use of "a" or "an" is determined by the pronunciation of the first letter. The pronunciation of the letter "R" starts with a vowel sound so "an" is appropriate here.

See http://english.stackexchange.com/a/1017

@Jojoshua
Copy link
Author

The typo was read for ready. The a vs an is debatable.

@steveklabnik
Copy link
Member

@Jojoshua ha! Submitting to fix, good eyes.

@Gankra Gankra added the A-docs label Jan 21, 2015
steveklabnik added a commit to steveklabnik/rust that referenced this issue Jan 21, 2015
steveklabnik added a commit to steveklabnik/rust that referenced this issue Jan 22, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants