Apply suggestions from code review

Improve docs on caching_sha2_password packets
blackbeam · Jan 12, 2024 · 9ddcb00 · 9ddcb00
1 parent 9c2b718
commit 9ddcb00
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/src/packets/caching_sha2_password.rs b/src/packets/caching_sha2_password.rs
@@ -11,8 +11,10 @@ define_header!(
     0x02
 );
 
-/// A request for a public RSA key, used by some authentication mechanisms
-/// to add a layer of protection to an unsecured channel.
+/// A client request for a server public RSA key, used by some authentication mechanisms
+/// to add a layer of protection to an unsecured channel (see [`PublicKeyResponse`]).
+///
+/// [`PublicKeyResponse`]: crate::packets::PublicKeyResponse
 #[derive(Debug, Clone, Eq, PartialEq)]
 pub struct PublicKeyRequest {
     __header: PublicKeyRequestHeader,

diff --git a/src/packets/mod.rs b/src/packets/mod.rs
@@ -1249,7 +1249,9 @@ define_header!(
     0x01
 );
 
-/// A response containing a public RSA key for authentication protection.
+/// A server response to a [`PublicKeyRequest`] containing a public RSA key for authentication protection.
+///
+/// [`PublicKeyRequest`]: crate::packets::caching_sha2_password::PublicKeyRequest
 #[derive(Debug, Clone, Eq, PartialEq)]
 pub struct PublicKeyResponse<'a> {
     __header: PublicKeyResponseHeader,