Improve sftp::mkdir documentation

alexcrichton · Sep 21, 2023 · 45c6e25 · 45c6e25
1 parent c1e5cb8
commit 45c6e25
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/sftp.rs b/src/sftp.rs
@@ -173,7 +173,7 @@ impl Sftp {
 
     /// Open a handle to a file.
     ///
-    /// The mode will represent the permissions ([Wikipedia](<https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation>)).
+    /// The mode will represent the permissions for the file ([Wikipedia](<https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation>)).
     pub fn open_mode(
         &self,
         filename: &Path,
@@ -250,6 +250,8 @@ impl Sftp {
     }
 
     /// Create a directory on the remote file system.
+    /// 
+    /// The mode will set the permissions of the new directory ([Wikipedia](<https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation>)).
     pub fn mkdir(&self, filename: &Path, mode: i32) -> Result<(), Error> {
         let filename = CString::new(util::path2bytes(filename)?)?;
         let locked = self.lock()?;