summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
Diffstat (limited to 'include')
-rw-r--r--include/users.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/include/users.h b/include/users.h
index 4029daa53..6408bc45f 100644
--- a/include/users.h
+++ b/include/users.h
@@ -588,7 +588,7 @@ class CoreExport User : public Extensible
bool ChangeName(const std::string& gecos);
/** Change a user's nick
- * @param newnick The new nick
+ * @param newnick The new nick. If equal to the users uuid, the nick change always succeeds.
* @return True if the change succeeded
*/
bool ChangeNick(const std::string& newnick, time_t newts = 0);