From fd497764f81e35a4299a58bb6dded04db188d0e1 Mon Sep 17 00:00:00 2001
From: Tom <25043847+Douile@users.noreply.github.com>
Date: Tue, 6 Feb 2024 15:06:54 +0000
Subject: [PATCH] feat: Improve doc-comments for ErrorKind (#186)

* Improve doc-comments for ErrorKind

* error: Improve ErrorKind::BadGame doc comment

* error: fmt ErrorKind doc comments
---
 crates/lib/src/errors/kind.rs | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/crates/lib/src/errors/kind.rs b/crates/lib/src/errors/kind.rs
index 65c0d1b..8cbf1ef 100644
--- a/crates/lib/src/errors/kind.rs
+++ b/crates/lib/src/errors/kind.rs
@@ -12,7 +12,7 @@ pub enum GDErrorKind {
     PacketBad,
     /// Couldn't send the packet.
     PacketSend,
-    /// Couldn't send the receive.
+    /// Couldn't receieve data when it was expected.
     PacketReceive,
     /// Couldn't decompress data.
     Decompress,
@@ -20,11 +20,13 @@ pub enum GDErrorKind {
     SocketConnect,
     /// Couldn't bind a socket.
     SocketBind,
-    /// Invalid input.
+    /// Invalid input to the library.
     InvalidInput,
-    /// The server queried is not the queried game server.
+    /// The server response indicated that it is a different game than the game
+    /// queried.
     BadGame,
-    /// Couldn't automatically query.
+    /// Couldn't automatically query (none of the attempted protocols were
+    /// successful).
     AutoQuery,
     /// A protocol-defined expected format was not met.
     ProtocolFormat,