From dfdaea786b9f04c2b189db5d2fffb08b0ea4f739 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?K=C3=A9vin=20Commaille?= <zecakeh@tedomum.fr>
Date: Tue, 26 Apr 2022 18:49:21 +0200
Subject: [PATCH] docs: Document RumaApiError variants

---
 crates/matrix-sdk/src/error.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/crates/matrix-sdk/src/error.rs b/crates/matrix-sdk/src/error.rs
index 84d047478..91a708945 100644
--- a/crates/matrix-sdk/src/error.rs
+++ b/crates/matrix-sdk/src/error.rs
@@ -47,8 +47,11 @@ pub type HttpResult<T> = std::result::Result<T, HttpError>;
 /// representation if the endpoint is from that.
 #[derive(Error, Debug)]
 pub enum RumaApiError {
+    /// A client API response error.
     #[error(transparent)]
     ClientApi(ruma::api::client::Error),
+
+    /// Another API reponse error.
     #[error(transparent)]
     Other(ruma::api::error::MatrixError),
 }