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

index adbfcc366af9f84c2c13a5e11bb48b9850e480cd..062186ef70866fec67ef4d4676950b5bc3dc02e1 100644 (file)
@@ -106,19 +106,19 @@ pub struct File {
 /// Iterator over the entries in a directory.
 ///
 /// This iterator is returned from the [`read_dir`] function of this module and
-/// will yield instances of `io::Result<DirEntry>`. Through a [`DirEntry`]
+/// will yield instances of [`io::Result`]`<`[`DirEntry`]`>`. Through a [`DirEntry`]
 /// information like the entry's path and possibly other metadata can be
 /// learned.
 ///
-/// [`read_dir`]: fn.read_dir.html
-/// [`DirEntry`]: struct.DirEntry.html
-///
 /// # Errors
 ///
-/// This [`io::Result`] will be an `Err` if there's some sort of intermittent
+/// This [`io::Result`] will be an [`Err`] if there's some sort of intermittent
 /// IO error during iteration.
 ///
+/// [`read_dir`]: fn.read_dir.html
+/// [`DirEntry`]: struct.DirEntry.html
 /// [`io::Result`]: ../io/type.Result.html
+/// [`Err`]: ../result/enum.Result.html#variant.Err
 #[stable(feature = "rust1", since = "1.0.0")]
 #[derive(Debug)]
 pub struct ReadDir(fs_imp::ReadDir);