about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorPeter Gerber <peter@arbitrary.ch>2017-04-01 15:58:37 +0200
committerPeter Gerber <peter@arbitrary.ch>2017-04-02 04:06:29 +0200
commitff4febf8eafa86bc7a3130d68f81c852a9da3661 (patch)
tree97a0bbdfb16f145f3c9ac13effe230b8cc12c445 /src/libstd
parenta9329d3aa3974cfe7fda57a67b3898434f410131 (diff)
downloadrust-ff4febf8eafa86bc7a3130d68f81c852a9da3661.tar.gz
rust-ff4febf8eafa86bc7a3130d68f81c852a9da3661.zip
Improve documentation for `std::fs::DirBuilder`
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/fs.rs9
1 files changed, 6 insertions, 3 deletions
diff --git a/src/libstd/fs.rs b/src/libstd/fs.rs
index ca26dc9527c..1b00eb95de2 100644
--- a/src/libstd/fs.rs
+++ b/src/libstd/fs.rs
@@ -1726,9 +1726,9 @@ impl DirBuilder {
         }
     }
 
-    /// Indicate that directories create should be created recursively, creating
-    /// all parent directories if they do not exist with the same security and
-    /// permissions settings.
+    /// Indicates that directories should be created recursively, creating all
+    /// parent directories. Parents that do not exist are created with the same
+    /// security and permissions settings.
     ///
     /// This option defaults to `false`.
     ///
@@ -1749,6 +1749,9 @@ impl DirBuilder {
     /// Create the specified directory with the options configured in this
     /// builder.
     ///
+    /// It is considered an error if the directory already exists unless
+    /// recursive mode is enabled.
+    ///
     /// # Examples
     ///
     /// ```no_run