]> git.lizzy.rs Git - rust.git/commitdiff
Add missing links in io::Error docs
authorGuillaume Gomez <guillaume1.gomez@gmail.com>
Thu, 10 Aug 2017 21:05:50 +0000 (23:05 +0200)
committerGuillaume Gomez <guillaume1.gomez@gmail.com>
Thu, 10 Aug 2017 21:05:50 +0000 (23:05 +0200)
src/libstd/io/error.rs

index 0a5804a774411c0b078d8070bc5b944283461dc2..12716b9b502e09d6375d7db6c523fc745fb3bbb2 100644 (file)
 /// 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
 ///