Merge pull request #116 from brotskydotcom/readme-example-fix

Author: brotskydotcom

CHANGELOG.md

@@ -1,3 +1,6 @@
+## Version 2.0.1
+- fix the example in the README.
+
 ## Version 2.0
 - (API change) Allow creation of entries to fail.
 - (API change) Introduce an ambiguous error on credential lookup.

Cargo.toml

@@ -6,7 +6,7 @@ keywords = ["password", "credential", "keychain", "keyring", "cross-platform"]
 license = "MIT OR Apache-2.0"
 name = "keyring"
 repository = "https://github.com/hwchen/keyring-rs.git"
-version = "2.0.0"
+version = "2.0.1"
 edition = "2021"
 exclude = [".github/"]
 readme = "README.md"

README.md

@@ -30,7 +30,7 @@ and removed using the `delete_password` method.
 use keyring::{Entry, Result};
 
 fn main() -> Result<()> {
-    let entry = Entry::new("my_service", "my_name");
+    let entry = Entry::new("my_service", "my_name")?;
     entry.set_password("topS3cr3tP4$$w0rd")?;
     let password = entry.get_password()?;
     println!("My password is '{}'", password);

src/lib.rs

@@ -258,8 +258,8 @@ impl Entry {
     }
 }
 
-#[cfg(test)]
-doc_comment::doctest!("../README.md");
+#[cfg(doctest)]
+doc_comment::doctest!("../README.md", readme);
 
 #[cfg(test)]
 /// There are no actual tests in this module.