Rollup merge of #133183 - n0toose:improve-remove-dir-docs, r=joboet

Mention std::fs::remove_dir_all in std::fs::remove_dir
This commit is contained in:
Matthias Krüger 2024-11-19 22:24:45 +01:00 committed by GitHub
commit d5dca43df6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -2738,6 +2738,10 @@ pub fn create_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
/// Removes an empty directory. /// Removes an empty directory.
/// ///
/// If you want to remove a directory that is not empty, as well as all
/// of its contents recursively, consider using [`remove_dir_all`]
/// instead.
///
/// # Platform-specific behavior /// # Platform-specific behavior
/// ///
/// This function currently corresponds to the `rmdir` function on Unix /// This function currently corresponds to the `rmdir` function on Unix