diff options
author | Eliza Weisman <eliza@buoyant.io> | 2019-11-21 14:09:10 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-11-21 14:09:10 -0800 |
commit | 6866fe426cfab0e4da3e88c673f7bef141259bb6 (patch) | |
tree | c73cb803f3de2ae9a326606d9bb3cf51a2bf40f0 /tokio/tests/rt_common.rs | |
parent | d88846c4ebba8239f6c3b4465786869333451e6b (diff) |
docs: expand and update crate-level docs (#1806)
## Motivation
Tokio's crate-level docs are currently pretty sparse, and in some cases
reference old names for APIs. Before 0.2 is released, they could use a
fresh coat of paint.
## Solution
This branch reworks and expands the `lib.rs` docs. In particular, I've
added a new "A Tour of Tokio" section, inspired by the [standard
library's similarly-named section][std]. This section lists all of
`tokio`'s public modules, and summarizes their major APIs. It also lists
the feature flags necessary to enable those APIs.
[std]: https://doc.rust-lang.org/std/index.html#a-tour-of-the-rust-standard-library
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
Diffstat (limited to 'tokio/tests/rt_common.rs')
0 files changed, 0 insertions, 0 deletions