Fixes outdated documentation in rpassword

conradkleinespel · conradkleinespel · commit d8a5af59ff2f · 2025-04-20T16:09:00.000+02:00
diff --git a/src/lib.rs b/src/lib.rs
@@ -238,15 +238,15 @@ pub use wasm::read_password;
 #[cfg(target_family = "windows")]
 pub use windows::read_password;
 
-/// Reads a password from anything that implements BufRead
+/// Reads a password from `impl BufRead`
 pub fn read_password_from_bufread(reader: &mut impl BufRead) -> std::io::Result<String> {
     let mut password = SafeString::new();
     reader.read_line(&mut password)?;
 
     fix_line_issues(password.into_inner())
 }
 
-/// Prompts on the TTY and then reads a password from anything that implements BufRead
+/// Prompts on `impl Write` and then reads a password from `impl BufRead`
 pub fn prompt_password_from_bufread(
     reader: &mut impl BufRead,
     writer: &mut impl Write,
