The Standard Library Documentation Checklist

[steveklabnik]

I've been doing work on random parts of the standard library, but it's time to get systematic.

Here's a list of all of the top-level modules in std, with separate tracking issues for each part. Documentation is never done, but I'd at least like to ensure that every module is seen at least once.

PRs will be sent for consistency, more examples, better explanations, all the usual stuff. But here's how we can track progress.

One specific area where we can do much better is linking of types to their docs in text explanations.

• home page API Docs: home page #29330
• array API Docs: array #29331
• bool API Docs: bool #29332
• char API Docs: char #29333
• floats API Docs: primitive floats #29334
• integers API Docs: primitive integers #29335
• raw pointers API docs: raw pointers #29336
• slices API Docs: slices #29337
• str API Docs: str #29338
• tuples API Docs: tuple #29339
• any API Docs: any #29340
• borrow API Docs: borrow #29342
• boxed API Docs: boxed #29343
• cell API Docs: cell #29344
• char API Docs: char #29345
• clone API Docs: clone #29346
• cmp API Docs: cmp #29347
• collections API Docs: collections #29348
• convert API Docs: convert #29349
• default API Docs: default #29350
• env API Docs: env #29351
• error API Docs: error #29352
• std::float API Docs: std::floating point stuff #29353
• ffi API Docs: ffi #29354
• fmt API Docs: fmt #29355
• fs API Docs: fs #29356
• hash API Docs: hash #29357
• std::integer API Docs: std::integer stuff #29358
• io API Docs: io #29359
• iter API Docs: std::iter #29360
• marker API Docs: marker #29361
• mem API Docs: std::mem #29362
• net API Docs: net #29363
• num API Docs: num #29364
• ops API Docs: std::ops #29365
• option API Docs: option #29366
• os API Docs: os #29367
• prelude API Docs: prelude #29369
• process API Docs: process #29370
• ptr API Docs: ptr #29371
• rc API Docs: rc #29372
• result API Docs: result #29373
• std::slice API Docs: std::slice #29374
• std::str API Docs: std::str #29375
• string API Docs: string #29376
• sync API Docs: sync #29377
• thread API Docs: thread #29378
• time API Docs: time #29379
• vec API Docs: vec #29380
• macros API Docs: macros #29381
• std::char API Docs: std::char #29428