Various documentation cleanups #1132
Conversation
And replace it with the try (`?`) operator.
Hopefully this will be useful when porting Mio to another OS or selector (io_uring anyone?).
Don't advocate calling Events::clear before calling Poll::poll as that is not needed.
Not an interesting example. Furthermore we don't guarantee that the size of Interests will always remain the same.
No longer true.
| /// [`poll`]: Poll::poll | ||
| /// [`reregister`]: Registry::reregister | ||
| /// [`deregister`]: Registry::deregister | ||
| /// [`Token`]: Token |
There was a problem hiding this comment.
It looks like a lot of the links don't work properly in the documentation, but since this PR is changing these they should be:
/// [`poll`]: struct.Poll.html#method.poll
/// [`reregister`]: #method.reregister
/// [`deregister`]: #method.deregister
/// [`Token`]: struct.Token.html
There was a problem hiding this comment.
These are intra docs links. They link e.g. the Poll::poll method. These should work, or at least don't give any warning on my machine.
There was a problem hiding this comment.
So running cargo doc --open locally and clicking these links in the Registry documentation works? It does not me; it loads a blank page.
There was a problem hiding this comment.
As discussed on Discord; this is nightly only (rust-lang/rust#63305).
There was a problem hiding this comment.
@Thomasdezeeuw If you want to keep these as intra doc links I'm fine with that. I'm not sure from the Discord discussion if you intended to at least just change these ones back.
|
@kleimkuhler I'm keeping the intra-docs as is for now. Once we're ready to release a v0.7 we'll change all links I've opened #1136 for it. |
No description provided.