password-hash: rustdoc fixups (#2336)

Author: tarcieri

password-hash/src/lib.rs

@@ -133,12 +133,12 @@ pub trait PasswordHasher<H> {
 
 /// Trait for password hashing functions which support customization.
 ///
-/// Generic around a password hash to be returned (typically [`PasswordHash`])
+/// Generic around a password hash to be returned (typically [`phc::PasswordHash`]).
 pub trait CustomizedPasswordHasher<H> {
     /// Algorithm-specific parameters.
     type Params: Clone + Debug + Default;
 
-    /// Compute a [`PasswordHash`] from the provided password using an explicit set of customized
+    /// Compute a password hash from the provided password using an explicit set of customized
     /// algorithm parameters as opposed to the defaults.
     ///
     /// When in doubt, use [`PasswordHasher::hash_password`] instead.
@@ -156,8 +156,8 @@ pub trait CustomizedPasswordHasher<H> {
         params: Self::Params,
     ) -> Result<H>;
 
-    /// Compute a [`PasswordHash`] using customized parameters only, using the default
-    /// algorithm and version.
+    /// Compute a password hash using customized parameters only, using the default algorithm and
+    /// version.
     ///
     /// # Errors
     /// These will vary by algorithm/implementation of this trait, but may be due to:
@@ -175,20 +175,20 @@ pub trait CustomizedPasswordHasher<H> {
 
 /// Trait for password verification.
 ///
-/// Generic around a password hash to be returned (typically [`phc::PasswordHash`])
+/// Generic around a password hash to be returned (typically [`phc::PasswordHash`]).
 ///
 /// Automatically impl'd for type that impl [`PasswordHasher`] with [`phc::PasswordHash`] as `H`.
 ///
-/// This trait is object safe and can be used to implement abstractions over
-/// multiple password hashing algorithms.
+/// This trait is object safe and can be used to implement abstractions over multiple password
+/// hashing algorithms.
 pub trait PasswordVerifier<H: ?Sized> {
     /// Compute this password hashing function against the provided password using the parameters
     /// from the provided password hash and see if the computed output matches.
     ///
     /// # Errors
-    /// - Returns `Error::Algorithm` if the algorithm being requested by the hash `H` is unsupported
-    /// - Returns `Error::PasswordInvalid` if the hash for the supplied password does not match
-    ///   the provided hash
+    /// - Returns [`Error::Algorithm`] if the algorithm requested by the hash `H` is unsupported
+    /// - Returns [`Error::PasswordInvalid`] if the computed hash for the supplied password does not
+    ///   match the expected hash
     /// - May return other algorithm-specific errors
     fn verify_password(&self, password: &[u8], hash: &H) -> Result<()>;
 }