File tree 1 file changed +5
-3
lines changed
1 file changed +5
-3
lines changed Original file line number Diff line number Diff line change @@ -2841,9 +2841,11 @@ pub fn remove_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
2841
2841
///
2842
2842
/// See [`fs::remove_file`] and [`fs::remove_dir`].
2843
2843
///
2844
- /// `remove_dir_all` will fail if `remove_dir` or `remove_file` fail on any constituent paths, including the root `path`.
2845
- /// As a result, the directory you are deleting must exist, meaning that this function is not idempotent.
2846
- /// Additionally, `remove_dir_all` will also fail if the `path` is not a directory.
2844
+ /// [`remove_dir_all`] will fail if [`remove_dir`] or [`remove_file`] fail on *any* constituent
2845
+ /// paths, *including* the root `path`. Consequently,
2846
+ ///
2847
+ /// - The directory you are deleting *must* exist, meaning that this function is *not idempotent*.
2848
+ /// - [`remove_dir_all`] will fail if the `path` is *not* a directory.
2847
2849
///
2848
2850
/// Consider ignoring the error if validating the removal is not required for your use case.
2849
2851
///
You can’t perform that action at this time.
0 commit comments