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 warning in tokio-io #556

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

Cargo doc warning in tokio-io #556

kpp opened this issue Aug 21, 2018 · 1 comment

Comments

@kpp
Copy link
Contributor

kpp commented Aug 21, 2018

warning: `read` is both a type and a function
  --> tokio-io/src/io/read.rs:29:1
   |
29 | / /// A future which can be used to easily read available number of bytes to fill
30 | | /// a buffer.
31 | | ///
32 | | /// Created by the [`read`] function.
   | |_____________________________________^
   |
   = help: try `type@read` if you want to select the type, or `read()` if you want to select the function

also #![deny(warnings)] should be put on top of tokio-io/lib.rs

@kpp
Copy link
Contributor Author

kpp commented Aug 30, 2018

diff --git a/tokio-io/src/codec/mod.rs b/tokio-io/src/codec/mod.rs
index 6ef3d5e..9e739bf 100644
--- a/tokio-io/src/codec/mod.rs
+++ b/tokio-io/src/codec/mod.rs
@@ -46,7 +46,7 @@ pub mod length_delimited {
     //! # Getting started
     //!
     //! If implementing a protocol from scratch, using length delimited framing
-    //! is an easy way to get started. [`Framed::new()`] will adapt a
+    //! is an easy way to get started. `Framed::new()` will adapt a
     //! full-duplex byte stream with a length delimited framer using default
     //! configuration values.
     //!
diff --git a/tokio-timer/src/timeout.rs b/tokio-timer/src/timeout.rs
index 8d31ea5..d105efc 100644
--- a/tokio-timer/src/timeout.rs
+++ b/tokio-timer/src/timeout.rs
@@ -57,7 +57,7 @@ use std::time::{Instant, Duration};
 /// Cancelling a `Timeout` is done by dropping the value. No additional cleanup
 /// or other work is required.
 ///
-/// The original future or stream may be obtained by calling [`into_inner`]. This
+/// The original future or stream may be obtained by calling `into_inner`. This
 /// consumes the `Timeout`.
 ///
 /// [`Error`]: struct.Error.html

@kpp kpp closed this as completed Dec 28, 2018
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

2 participants