Skip to content

Commit

Permalink
fixes missing/bad inline docs
Browse files Browse the repository at this point in the history
  • Loading branch information
conradkleinespel committed Jul 31, 2017
1 parent 0340cd8 commit 926efe9
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]

name = "rpassword"
version = "1.0.0"
version = "1.0.1"
authors = ["Conrad Kleinespel <conradk@conradk.com>"]
description = "Read passwords in console applications."
license = "Apache-2.0"
Expand Down
9 changes: 4 additions & 5 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ mod unix {
}
}

/// Reads a password from STDIN
pub fn read_password() -> ::std::io::Result<String> {
let mut password = String::new();

Expand Down Expand Up @@ -128,6 +129,7 @@ mod windows {
extern crate winapi;
extern crate kernel32;

/// Reads a password from STDIN
pub fn read_password() -> ::std::io::Result<String> {
let mut password = String::new();

Expand Down Expand Up @@ -175,27 +177,24 @@ pub use unix::read_password;
#[cfg(windows)]
pub use windows::read_password;

/// Reads a password from STDIN.
#[deprecated(since = "1.0.0", note = "use `rprompt` crate and `rprompt::read_reply` instead")]
pub fn read_response() -> std::io::Result<String> {
rprompt::read_reply()
}

/// Prompts for a response on STDOUT and reads it from STDIN.
#[deprecated(since = "1.0.0",
note = "use `rprompt` crate and `rprompt::prompt_reply_stdout` instead")]
pub fn prompt_response_stdout(prompt: &str) -> std::io::Result<String> {
rprompt::prompt_reply_stdout(prompt)
}

/// Prompts for a password on STDERR and reads it from STDIN.
#[deprecated(since = "1.0.0",
note = "use `rprompt` crate and `rprompt::prompt_reply_stderr` instead")]
pub fn prompt_response_stderr(prompt: &str) -> std::io::Result<String> {
rprompt::prompt_reply_stderr(prompt)
}

/// Prompts for a password on STDOUT and reads it from STDIN.
/// Prompts for a password on STDOUT and reads it from STDIN
pub fn prompt_password_stdout(prompt: &str) -> std::io::Result<String> {
let mut stdout = std::io::stdout();

Expand All @@ -204,7 +203,7 @@ pub fn prompt_password_stdout(prompt: &str) -> std::io::Result<String> {
read_password()
}

/// Prompts for a password on STDERR and reads it from STDIN.
/// Prompts for a password on STDERR and reads it from STDIN
pub fn prompt_password_stderr(prompt: &str) -> std::io::Result<String> {
let mut stderr = std::io::stderr();

Expand Down

0 comments on commit 926efe9

Please sign in to comment.