Scrub for broken links

[dtolnay]

The documentation of mio::event::Event has one: [readiness state]. I recall noticing a few others. Let's go through systematically and clean these up.

---

[dtolnay]

This can happen in two phases -- it would be a huge help if someone could run through the docs and make a list of the broken links in a comment here, then they can be fixed in bulk. Even going through part of the docs would be helpful. Just let us know which parts you covered.

Bonus points for implementing a warning in rustdoc to catch these automatically!

[dtolnay]

[set_readiness] and [portability] are broken in mio::Registration.

[justinmayhew]

I went through every page on the docs and fixed most of them. The only problem I ran into is that Events is exported as both mio::Events and mio::event::Events and I can only get the links on one of them working due to needing the ../ prefix for the mio::event::Events one.

I'm not too familiar with how links work in Rust docs and couldn't find any documentation on this. Any suggestions on how we could handle this?

[dtolnay]

I don't know either. For now pick one of the pages to make correct. Also make sure there is a rustdoc issue to make this possible to handle correctly and/or to document how to handle this correctly.