From 48ecf50973b759eb6ca1940650e074f2b2a925f3 Mon Sep 17 00:00:00 2001
From: avdb13 <avdb@keemail.me>
Date: Thu, 13 Feb 2025 21:23:55 +0000
Subject: [PATCH] update documentation of `service::users::Data::iter`

---
 src/database/key_value/users.rs | 4 ++--
 src/service/users.rs            | 4 ++--
 src/service/users/data.rs       | 4 ++--
 3 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/src/database/key_value/users.rs b/src/database/key_value/users.rs
index e3fdb95e..4c2295de 100644
--- a/src/database/key_value/users.rs
+++ b/src/database/key_value/users.rs
@@ -35,7 +35,7 @@ impl service::users::Data for KeyValueDatabase {
             .is_empty())
     }
 
-    /// Returns the number of users registered on this server.
+    /// Returns the number of local and remote users known by this server.
     fn count(&self) -> Result<usize> {
         Ok(self.userid_password.iter().count())
     }
@@ -84,7 +84,7 @@ impl service::users::Data for KeyValueDatabase {
         )
     }
 
-    /// Returns an iterator over all users on this homeserver.
+    /// Returns an iterator over all local and remote users on this homeserver.
     fn iter<'a>(
         &'a self,
     ) -> Box<dyn Iterator<Item = Result<OwnedUserId>> + 'a> {
diff --git a/src/service/users.rs b/src/service/users.rs
index 3ee47386..b05a2ccb 100644
--- a/src/service/users.rs
+++ b/src/service/users.rs
@@ -282,7 +282,7 @@ impl Service {
         Ok(())
     }
 
-    /// Returns the number of users registered on this server.
+    /// Returns the number of local and remote users known by this server.
     pub(crate) fn count(&self) -> Result<usize> {
         self.db.count()
     }
@@ -295,7 +295,7 @@ impl Service {
         self.db.find_from_token(token)
     }
 
-    /// Returns an iterator over all users on this homeserver.
+    /// Returns an iterator over all local and remote users on this homeserver.
     pub(crate) fn iter(
         &self,
     ) -> impl Iterator<Item = Result<OwnedUserId>> + '_ {
diff --git a/src/service/users/data.rs b/src/service/users/data.rs
index 630ded7d..579bdfb0 100644
--- a/src/service/users/data.rs
+++ b/src/service/users/data.rs
@@ -18,7 +18,7 @@ pub(crate) trait Data: Send + Sync {
     /// Check if account is deactivated
     fn is_deactivated(&self, user_id: &UserId) -> Result<bool>;
 
-    /// Returns the number of users registered on this server.
+    /// Returns the number of local and remote users known by this server.
     fn count(&self) -> Result<usize>;
 
     /// Find out which user an access token belongs to.
@@ -27,7 +27,7 @@ pub(crate) trait Data: Send + Sync {
         token: &str,
     ) -> Result<Option<(OwnedUserId, String)>>;
 
-    /// Returns an iterator over all users on this homeserver.
+    /// Returns an iterator over all local and remote users on this homeserver.
     fn iter<'a>(&'a self)
         -> Box<dyn Iterator<Item = Result<OwnedUserId>> + 'a>;