From 93969734f6a8f38e95c7038c926ab2504e87dad6 Mon Sep 17 00:00:00 2001 From: Guillaume Gomez Date: Mon, 8 Jan 2018 14:16:16 +0100 Subject: [PATCH] Add missing links --- src/libcore/fmt/mod.rs | 5 ++++- src/libstd/io/mod.rs | 21 ++++++++++++++------- 2 files changed, 18 insertions(+), 8 deletions(-) diff --git a/src/libcore/fmt/mod.rs b/src/libcore/fmt/mod.rs index 0f541a4b537..65aacb23bd7 100644 --- a/src/libcore/fmt/mod.rs +++ b/src/libcore/fmt/mod.rs @@ -83,9 +83,12 @@ pub type Result = result::Result<(), Error>; /// some other means. /// /// An important thing to remember is that the type `fmt::Error` should not be -/// confused with `std::io::Error` or `std::error::Error`, which you may also +/// confused with [`std::io::Error`] or [`std::error::Error`], which you may also /// have in scope. /// +/// [`std::io::Error`]: ../../std/io/struct.Error.html +/// [`std::error::Error`]: ../../std/error/trait.Error.html +/// /// # Examples /// /// ```rust diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs index ad9cf1eed70..33d11ebb350 100644 --- a/src/libstd/io/mod.rs +++ b/src/libstd/io/mod.rs @@ -997,9 +997,9 @@ pub trait Write { /// /// Calls to `write` are not guaranteed to block waiting for data to be /// written, and a write which would otherwise block can be indicated through - /// an `Err` variant. + /// an [`Err`] variant. /// - /// If the return value is `Ok(n)` then it must be guaranteed that + /// If the return value is [`Ok(n)`] then it must be guaranteed that /// `0 <= n <= buf.len()`. A return value of `0` typically means that the /// underlying object is no longer able to accept bytes and will likely not /// be able to in the future as well, or that the buffer provided is empty. @@ -1013,9 +1013,13 @@ pub trait Write { /// It is **not** considered an error if the entire buffer could not be /// written to this writer. /// - /// An error of the `ErrorKind::Interrupted` kind is non-fatal and the + /// An error of the [`ErrorKind::Interrupted`] kind is non-fatal and the /// write operation should be retried if there is nothing else to do. /// + /// [`Err`]: ../../std/result/enum.Result.html#variant.Err + /// [`Ok(n)`]: ../../std/result/enum.Result.html#variant.Ok + /// [`ErrorKind::Interrupted`]: ../../std/io/enum.ErrorKind.html#variant.Interrupted + /// /// # Examples /// /// ``` @@ -1061,17 +1065,20 @@ pub trait Write { /// Attempts to write an entire buffer into this write. /// - /// This method will continuously call `write` until there is no more data - /// to be written or an error of non-`ErrorKind::Interrupted` kind is + /// This method will continuously call [`write`] until there is no more data + /// to be written or an error of non-[`ErrorKind::Interrupted`] kind is /// returned. This method will not return until the entire buffer has been /// successfully written or such an error occurs. The first error that is - /// not of `ErrorKind::Interrupted` kind generated from this method will be + /// not of [`ErrorKind::Interrupted`] kind generated from this method will be /// returned. /// /// # Errors /// /// This function will return the first error of - /// non-`ErrorKind::Interrupted` kind that `write` returns. + /// non-[`ErrorKind::Interrupted`] kind that [`write`] returns. + /// + /// [`ErrorKind::Interrupted`]: ../../std/io/enum.ErrorKind.html#variant.Interrupted + /// [`write`]: #tymethod.write /// /// # Examples ///