Giters

conradkleinespel / rpassword

Cross platform Rust library to read a password in the terminal (Linux, BSD, OSX, Windows, WASM).

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

differentiate read_password and read_response in docs

conradkleinespel opened this issue · comments

commented

Currently, the Rust docs do not differentiate the *_password and *_response functions, as can be seen here: https://docs.rs/rpassword/0.4.0/rpassword/. Their description is the same: "Reads a password from STDIN.". Same goes for the *_prompt_* functions.

Tasks:

  • improve docs to make it clear that *response* does not hide the typed password from the terminal
  • improve docs to make it clear that *password* hides the typed password from the terminal
  • bump the version to 0.4.1 in Cargo.toml so I can publish the new version to crates.io
  • add yourself to the contributors' list in README.md in alphabetical order

If you have any questions, just let us know and we'll jump in to help.