summaryrefslogtreecommitdiff
path: root/include/users.h
diff options
context:
space:
mode:
authorAttila Molnar <attilamolnar@hush.com>2014-07-03 12:36:14 +0200
committerAttila Molnar <attilamolnar@hush.com>2014-07-03 12:36:14 +0200
commit2eb0505a16cf5b70076bab2de494ef92b7e991d9 (patch)
tree89c10af83c07457640aecbfe42e56f7fde7ccb42 /include/users.h
parente827ec50d89e296ea6b19807631b56ed80e869a7 (diff)
User::ChangeNick() cannot fail if the new nick is the uuid, document this and rely on it
Diffstat (limited to 'include/users.h')
-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);