Repository navigation
API Docs: thread #29378
Description
Part of #29329
http://doc.rust-lang.org/std/thread/
Here's what needs to be done to close out this issue:
- the module docs are written a while ago, and contain some questionableish advice. It's not actually bad, it's just not the way I'd orient all of this. A particularly enthusiastic contributor could toss this out and re-write it from scratch. If the rest of this work gets done, we can close the ticket without doing this, but it would be nice.
-
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 topark -
spawnneeds 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.
Activity
steveklabnik commentedon Mar 8, 2017
I am happy to mentor anyone who wants to tackle this issue.
zimurgh commentedon Mar 25, 2017
I would be interested in taking on the documentation improvement of
Builderas a starter. I'd take on more, but no need to get ahead of myself.steveklabnik commentedon Mar 25, 2017
@OldManMike awesome! Please let me know if you need anything.
Rollup merge of rust-lang#41543 - z1mvader:master, r=steveklabnik
rap2hpoutre commentedon May 4, 2017
I would like to tackle this issue too and add an example on Result. Feel free to stop me if you are already working on it! (but it seems nobody took it right now)
69 remaining items
Rollup merge of rust-lang#41982 - gamazeps:thread-yield-now, r=Guilla…
Rollup merge of rust-lang#41994 - gamazeps:thread-builder, r=Guillaum…
Rollup merge of rust-lang#41995 - gamazeps:thread-localkey, r=frewsxcv
Rollup merge of rust-lang#41980 - gamazeps:thread-send, r=steveklabnik
Rollup merge of rust-lang#41980 - gamazeps:thread-send, r=steveklabnik
Rollup merge of rust-lang#41980 - gamazeps:thread-send, r=steveklabnik
Rollup merge of rust-lang#41980 - gamazeps:thread-send, r=steveklabnik
Rollup merge of rust-lang#41980 - gamazeps:thread-send, r=steveklabnik
Expands `detach` documentation in `thread::JoinHande`.
Rollup merge of rust-lang#41981 - gamazeps:thread-detach, r=frewsxcv
seanprashad commentedon Dec 8, 2017
Hi @steveklabnik! I'd LOVE to help bring this across the finish line but with the last documentation issue for the module docs. I'd greatly appreciate some guidance with where to start if it's possible 🙂
steveklabnik commentedon Dec 8, 2017
Hey @seanprashad that'd be amazing!
One option is
Which would be a bunch of work but might be the way to go.
Basically, I don't think the docs are organized well; they're kind of just a random collection of thoughts. So I think the first task is, how do we want to organize these docs? Generally, good module docs show an overview of the module conceptually, and then highlight key APIs. Maybe we can start there?
steveklabnik commentedon Jan 8, 2019
Quoting myself above:
We haven't come up with a good plan for the module docs, and so I'm going to close this ticket. If anyone has specific thoughts about improving them, please open a new ticket with details! Thanks.