improve sftp::open_mode documentation

alexcrichton · Sep 21, 2023 · c1e5cb8 · c1e5cb8
1 parent d9a1dfa
commit c1e5cb8
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/sftp.rs b/src/sftp.rs
@@ -172,6 +172,8 @@ 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>)).
  pub fn open_mode(
  &self,
  filename: &Path,