From: Guillaume Gomez Date: Thu, 10 Aug 2017 21:05:50 +0000 (+0200) Subject: Add missing links in io::Error docs X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=ac0ee51c1793029e93961e5a34458a6d3a049ac6;p=rust.git Add missing links in io::Error docs --- diff --git a/src/libstd/io/error.rs b/src/libstd/io/error.rs index 0a5804a7744..12716b9b502 100644 --- a/src/libstd/io/error.rs +++ b/src/libstd/io/error.rs @@ -17,17 +17,21 @@ /// A specialized [`Result`](../result/enum.Result.html) type for I/O /// operations. /// -/// This type is broadly used across `std::io` for any operation which may +/// This type is broadly used across [`std::io`] for any operation which may /// produce an error. /// -/// This typedef is generally used to avoid writing out `io::Error` directly and -/// is otherwise a direct mapping to `Result`. +/// This typedef is generally used to avoid writing out [`io::Error`] directly and +/// is otherwise a direct mapping to [`Result`]. /// -/// While usual Rust style is to import types directly, aliases of `Result` -/// often are not, to make it easier to distinguish between them. `Result` is -/// generally assumed to be `std::result::Result`, and so users of this alias +/// While usual Rust style is to import types directly, aliases of [`Result`] +/// often are not, to make it easier to distinguish between them. [`Result`] is +/// generally assumed to be [`std::result::Result`][`Result`], and so users of this alias /// will generally use `io::Result` instead of shadowing the prelude's import -/// of `std::result::Result`. +/// of [`std::result::Result`][`Result`]. +/// +/// [`std::io`]: ../io/index.html +/// [`io::Error`]: ../io/struct.Error.html +/// [`Result`]: ../result/enum.Result.html /// /// # Examples ///