From a99377020650d66409261368b00b8b003d619d5e Mon Sep 17 00:00:00 2001
From: Werner Kroneman <werner@wernerkroneman.nl>
Date: Sat, 9 Dec 2023 13:26:23 +0100
Subject: [PATCH] Clarified the doc comments for leave_room.

---
 xmpp/src/lib.rs | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/xmpp/src/lib.rs b/xmpp/src/lib.rs
index d391357..f463164 100644
--- a/xmpp/src/lib.rs
+++ b/xmpp/src/lib.rs
@@ -241,7 +241,7 @@ impl Agent {
         let _ = self.client.send_stanza(presence.into()).await;
     }
 
-    /// Send a "leave room" request to the server.
+    /// Send a "leave room" request to the server (specifically, an "unavailable" presence stanza).
     ///
     /// The returned future will resolve when the request has been sent,
     /// not when the room has actually been left.
@@ -250,6 +250,10 @@ impl Agent {
     ///
     /// See: https://xmpp.org/extensions/xep-0045.html#exit
     ///
+    /// Note that this method does NOT remove the room from the auto-join list; the latter
+    /// is more a list of bookmarks that the account knows about and that have a flag set
+    /// to indicate that they should be joined automatically after connecting (see the JoinRoom event).
+    ///
     /// # Arguments
     ///
     /// * `room_jid`: The JID of the room to leave.