From 9205c070485a234463119182bd976a0d45c1ace0 Mon Sep 17 00:00:00 2001
From: Torsten Flammiger <git@netfg.net>
Date: Sat, 15 Jan 2022 22:37:39 +0100
Subject: [PATCH] Update get_local_users description

---
 src/database/users.rs | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/src/database/users.rs b/src/database/users.rs
index 6f51e1f9..e510140d 100644
--- a/src/database/users.rs
+++ b/src/database/users.rs
@@ -123,10 +123,11 @@ impl Users {
         })
     }
 
-    /// Returns a list of local usernames, that is, a parseable username
-    /// with a password of length greater then zero bytes.
+    /// Returns a list of local users as list of usernames.
+    ///
+    /// A user account is considered `local` if the length of it's password
+    /// is greater then zero.
     /// If utils::string_from_bytes returns an error that username will be skipped
-    /// and the function will log the error
     #[tracing::instrument(skip(self))]
     pub fn get_local_users(&self) -> Result<Vec<String>> {
         let users: Vec<String> = self
@@ -138,6 +139,7 @@ impl Users {
     }
 
     /// A private helper to avoid double filtering the iterator
+    #[tracing::instrument(skip(self))]
     fn get_username_on_valid_password(&self, username: &[u8], password: &[u8]) -> Option<String> {
         // A valid password is not empty
         if password.len() > 0 {