about summary refs log tree commit diff
path: root/src/libstd/fs.rs
diff options
context:
space:
mode:
authorJonathan Turner <jonathandturner@users.noreply.github.com>2016-08-31 13:53:33 -0700
committerGitHub <noreply@github.com>2016-08-31 13:53:33 -0700
commit4bc5bcd812d16ff87282f616c6ce3432c0c9dac9 (patch)
treeca7edcc9a022372ec6a204a25e79c574ea848020 /src/libstd/fs.rs
parentc75fd78de3f01885d6b39a6ec532e68d183e1121 (diff)
parent96e3103cfec430ef03dee1a9125f2f519c7ebc22 (diff)
downloadrust-4bc5bcd812d16ff87282f616c6ce3432c0c9dac9.tar.gz
rust-4bc5bcd812d16ff87282f616c6ce3432c0c9dac9.zip
Rollup merge of #35786 - GuillaumeGomez:paths_doc, r=steveklabnik
Improve Path and PathBuf docs

r? @steveklabnik
Diffstat (limited to 'src/libstd/fs.rs')
-rw-r--r--src/libstd/fs.rs7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/libstd/fs.rs b/src/libstd/fs.rs
index f2374e722c1..698ec4f1b73 100644
--- a/src/libstd/fs.rs
+++ b/src/libstd/fs.rs
@@ -1510,8 +1510,11 @@ pub fn remove_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
 
 /// Returns an iterator over the entries within a directory.
 ///
-/// The iterator will yield instances of `io::Result<DirEntry>`. New errors may
-/// be encountered after an iterator is initially constructed.
+/// The iterator will yield instances of [`io::Result`]`<`[`DirEntry`]`>`.
+/// New errors may be encountered after an iterator is initially constructed.
+///
+/// [`io::Result`]: ../io/type.Result.html
+/// [`DirEntry`]: struct.DirEntry.html
 ///
 /// # Platform-specific behavior
 ///