Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cargo doc on nightly #861

Closed
kpp opened this issue Aug 6, 2018 · 1 comment
Closed

cargo doc on nightly #861

kpp opened this issue Aug 6, 2018 · 1 comment

Comments

@kpp
Copy link
Contributor

kpp commented Aug 6, 2018

mio breaks cargo doc for tokio on nightly.

These links are broken:

diff --git a/src/event_imp.rs b/src/event_imp.rs
index 6c60aad..a114182 100644
--- a/src/event_imp.rs
+++ b/src/event_imp.rs
@@ -708,7 +708,7 @@ impl Ready {
 
     /// Returns true if `Ready` is the empty set
     ///
-    /// See [`Poll`] for more documentation on polling.
+    /// See `Poll` for more documentation on polling.
     ///
     /// # Examples
     ///
diff --git a/src/poll.rs b/src/poll.rs
index a2fcf23..99090ac 100644
--- a/src/poll.rs
+++ b/src/poll.rs
@@ -695,8 +695,8 @@ impl Poll {
     /// readiness. `Poll` will only return readiness events for operations
     /// specified by this argument.
     ///
-    /// If a socket is registered with [`readable`] interest and the socket
-    /// becomes writable, no event will be returned from [`poll`].
+    /// If a socket is registered with `readable` interest and the socket
+    /// becomes writable, no event will be returned from `poll`.
     ///
     /// The readiness interest for an `Evented` handle can be changed at any
     /// time by calling [`reregister`].
@@ -860,7 +860,7 @@ impl Poll {
     ///
     /// When an `Evented` handle is deregistered, the `Poll` instance will
     /// no longer monitor it for readiness state changes. Unlike disabling
-    /// handles with [`oneshot`], deregistering clears up any internal resources
+    /// handles with `oneshot`, deregistering clears up any internal resources
     /// needed to track the handle.
     ///
     /// A handle can be passed back to `register` after it has been

I disabled "[autolink]" syntax but it should be fixed in a correct way.

@kpp
Copy link
Contributor Author

kpp commented Aug 21, 2018

There is still warning on master:

error: `[Poll]` cannot be resolved, ignoring it...
   --> /home/humbug/mio/src/event_imp.rs:711:14
    |
711 |     /// See [`Poll`] for more documentation on polling.
    |              ^^^^^^ cannot be resolved, ignoring
    |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant