-
-
Notifications
You must be signed in to change notification settings - Fork 15.4k
API Docs: thread #29378
Copy link
Copy link
Closed
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCCategory: An issue tracking the progress of sth. like the implementation of an RFCE-help-wantedCall for participation: Help is requested to fix this issue.Call for participation: Help is requested to fix this issue.E-mediumCall for participation: Medium difficulty. Experience needed to fix: Intermediate.Call for participation: Medium difficulty. Experience needed to fix: Intermediate.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.P-mediumMedium priorityMedium priority
Description
Metadata
Metadata
Assignees
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCCategory: An issue tracking the progress of sth. like the implementation of an RFCE-help-wantedCall for participation: Help is requested to fix this issue.Call for participation: Help is requested to fix this issue.E-mediumCall for participation: Medium difficulty. Experience needed to fix: Intermediate.Call for participation: Medium difficulty. Experience needed to fix: Intermediate.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.P-mediumMedium priorityMedium priority
Type
Fields
No fields configured for issues without a type.
Part of #29329
http://doc.rust-lang.org/std/thread/
Here's what needs to be done to close out this issue:
Builder's docs are... okay. Just very uninspired.JoinHandledoesn't go into enough detail, and should show off, for example, the detach behavior.LocalKeycould use some links and general cleanup.Threadhas very little and very boring docs.panickingcould use some more advice on when to use this.parkshould have its module documentation inlined here, and cleaned up.park_timeoutcould use links toparkspawnneeds a lot more docs generally. It's the main interface to this module!yield_nowdoesn't explain any of the "why".Resultshould at least show off the "use std::thread; thread::Result" pattern, like all module-specificResulttypes.