clean up docs

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

Author: yoshuawuyts

src/lib.rs

@@ -1,9 +1,7 @@
 //! A general purpose crate for working with timeouts and delays with futures.
 //!
 //! This crate is intended to provide general purpose timeouts and interval
-//! streams for working with `futures`. The implementation may not be optimized
-//! for your particular use case, though, so be sure to read up on the details
-//! if you're concerned about that!
+//! streams for working with `futures`.
 //!
 //! Basic usage of this crate is relatively simple:
 //!
@@ -19,43 +17,21 @@
 //! # }
 //! ```
 //!
-//! And you're off to the races! Check out the API documentation for more
-//! details about the various methods on `Delay`.
-//!
-//! # Implementation details
-//!
-//! The `Delay` type is powered by an associated `Timer`. By
-//! default constructors like `Delay::new` use a global
-//! instance of `Timer` to power their usage. This global `Timer` is spawned
-//! onto a helper thread which continuously runs in the background sending out
-//! timer notifications.
-//!
-//! If needed, however, a `Timer` can be constructed manually and the
-//! `Delay::new_handle`-style methods can be used to create delays/intervals
-//! associated with a specific instance of `Timer`. Each `Timer` has a
-//! `TimerHandle` type which is used to associate new objects to it.
-//!
-//! Note that there's also a `TimerHandle::set_fallback` method which will
-//! globally configure the fallback timer handle as well if you'd like to run
-//! your own timer.
-//!
-//! Finally, the implementation of `Timer` itself is currently a binary heap.
-//! Timer insertion is O(log n) where n is the number of active timers, and so
-//! is firing a timer (which invovles removing from the heap).
+//! And you're off to the races!
 
 #![deny(missing_docs)]
 #![warn(missing_debug_implementations)]
 
-use arc_list::{ArcList, Node};
-use heap::{Heap, Slot};
-use heap_timer::HeapTimer;
-use timer::{Timer, TimerHandle, ScheduledTimer};
-
-mod heap_timer;
 mod arc_list;
+mod delay;
 mod global;
 mod heap;
+mod heap_timer;
 mod timer;
 
-mod delay;
+use arc_list::{ArcList, Node};
+use heap::{Heap, Slot};
+use heap_timer::HeapTimer;
+use timer::{ScheduledTimer, Timer, TimerHandle};
+
 pub use self::delay::Delay;