Improved the overall documentation for the public and internal types in the package.

2026-03-23 00:25:38 +01:00
parent 69d7681139
commit cd01c27544
15 changed files with 62 additions and 56 deletions
@@ -14,19 +14,19 @@

 /// A representation of all the possible errors that the ``AmiiboService`` service could throw.
 public enum AmiiboServiceError: Error {
-    /// A bad request has been given to the client.
+    /// The request was malformed or contained invalid filter parameters.
    case badRequest
-    /// A call to an endpoint has been cancelled by the user.
+    /// The request was cancelled before a response was received.
    case cancelled
-    /// A response cannot be decoded.
+    /// The response body could not be decoded into the expected model.
    case decoding
-    /// An online service is not currently available.
+    /// The backend service is currently unreachable due to a network or server issue.
    case notAvailable
-    /// A response cannot be found.
+    /// No results were found matching the given filter criteria.
    case notFound
-    /// An undocumented/unsupported status code error.
+    /// The server returned an undocumented HTTP status code.
    case undocumented(_ statusCode: Int)
-    /// An unknown error.
+    /// An unexpected error that does not fall into any other category.
    case unknown
 }