Document Error::ApiError fields

2021-01-13 13:05:50 +01:00 · 2021-01-13 13:05:50 +01:00 · 7f5d67ba74
parent 7d86beba29
commit 7f5d67ba74
1 changed files with 7 additions and 1 deletions
--- a/src/error.rs
+++ b/src/error.rs
@ -7,7 +7,13 @@ use serde::Deserialize;
 pub enum Error {
    /// The API returned a non-200 status code.
    #[error("API error ({code}): {error}")]
-    Api { code: u16, error: String },
+    Api {
+        /// The HTTP status code.
+        code: u16,
+
+        /// A message describing the error.
+        error: String
+    },

    /// The input data could not be converted into JSON.
    #[error("could not convert request input into JSON")]