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.

Sign up for GitHub

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

Jump to bottom

std::thread::spawn documentation: Incorrect grammar #43435

Closed
joshlf opened this issue Jul 23, 2017 · 3 comments
Closed

std::thread::spawn documentation: Incorrect grammar #43435

joshlf opened this issue Jul 23, 2017 · 3 comments
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.

Comments

@joshlf
Copy link
Contributor

joshlf commented Jul 23, 2017

The documentation for std::thread::spawn contains the following sentence:

As a reminder, the Send marker trait, expresses that it is safe to be passed from thread to thread.

The second comma is grammatically incorrect; the sentence should read:

As a reminder, the Send marker trait expresses that it is safe to be passed from thread to thread.
@steveklabnik steveklabnik added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools labels Jul 24, 2017
@steveklabnik
Copy link
Member

steveklabnik commented Jul 24, 2017 •
edited
Loading

Yup, sounds good! Someone who wants to fix this would modify

rust/src/libstd/thread/mod.rs

Line 416 in b2c0707

/// As a reminder, the [`Send`] marker trait, expresses that it is safe to be

(I'm willing to help anyone who wants to send in a PR to fix this bug!)

@joshlf
Copy link
Contributor Author

joshlf commented Jul 24, 2017

I'm happy to do the PR myself, but I'm also happy to leave it as somebody's first PR.

@steveklabnik
Copy link
Member

Either way is fine by me! 👍

@joshlf joshlf mentioned this issue Jul 24, 2017
Merged
Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this issue Jul 26, 2017
@Mark-Simulacrum
Rollup merge of rust-lang#43456 - joshlf:spawn-doc-grammar, r=alexcri…
25e5f0a 
…chton

std::thread::spawn: Fix grammar in documentation

Closes rust-lang#43435.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@steveklabnik @joshlf