about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorCorey Farwell <coreyf@rwell.org>2017-04-05 12:44:32 -0400
committerGitHub <noreply@github.com>2017-04-05 12:44:32 -0400
commit263d5a0dafab35517b827c7f1134c6646d69b024 (patch)
tree613e8e556ed8a11ccc26c5c804858b0c4766a394 /src/libstd
parent4ed4c41e48c1b2c6aea489ce179df0f1954d6702 (diff)
parentff4febf8eafa86bc7a3130d68f81c852a9da3661 (diff)
Rollup merge of #41007 - pgerber:dir_builder, r=frewsxcv
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