about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorAlex Crichton <alex@alexcrichton.com>2016-11-04 16:49:30 -0700
committerAlex Crichton <alex@alexcrichton.com>2016-11-05 10:50:23 -0700
commit112a4ff748111a01fb737ac30e0b8554dabe8589 (patch)
treed686ef0ed1aedcba164a92325e426aacd958ee19 /src/libstd
parent8a38b24d952f0f13dbc436a68edb87a4b565f2e3 (diff)
parent942f909c1f6d2d203661831366e828ef030588c6 (diff)
downloadrust-112a4ff748111a01fb737ac30e0b8554dabe8589.tar.gz
rust-112a4ff748111a01fb737ac30e0b8554dabe8589.zip
Rollup merge of #37537 - GuillaumeGomez:error_kind_doc, r=steveklabnik
Add missing urls for ErrorKind's variants

r? @steveklabnik
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/io/error.rs9
1 files changed, 7 insertions, 2 deletions
diff --git a/src/libstd/io/error.rs b/src/libstd/io/error.rs
index 659c8aa5aea..795c89c0007 100644
--- a/src/libstd/io/error.rs
+++ b/src/libstd/io/error.rs
@@ -126,23 +126,28 @@ pub enum ErrorKind {
     InvalidInput,
     /// Data not valid for the operation were encountered.
     ///
-    /// Unlike `InvalidInput`, this typically means that the operation
+    /// Unlike [`InvalidInput`], this typically means that the operation
     /// parameters were valid, however the error was caused by malformed
     /// input data.
     ///
     /// For example, a function that reads a file into a string will error with
     /// `InvalidData` if the file's contents are not valid UTF-8.
+    ///
+    /// [`InvalidInput`]: #variant.InvalidInput
     #[stable(feature = "io_invalid_data", since = "1.2.0")]
     InvalidData,
     /// The I/O operation's timeout expired, causing it to be canceled.
     #[stable(feature = "rust1", since = "1.0.0")]
     TimedOut,
     /// An error returned when an operation could not be completed because a
-    /// call to `write` returned `Ok(0)`.
+    /// call to [`write()`] returned [`Ok(0)`].
     ///
     /// This typically means that an operation could only succeed if it wrote a
     /// particular number of bytes but only a smaller number of bytes could be
     /// written.
+    ///
+    /// [`write()`]: ../../std/io/trait.Write.html#tymethod.write
+    /// [`Ok(0)`]: ../../std/io/type.Result.html
     #[stable(feature = "rust1", since = "1.0.0")]
     WriteZero,
     /// This operation was interrupted.