From 905f1c326259b841e47f7bccdad1fe8c79e36e95 Mon Sep 17 00:00:00 2001
From: Souji <timoqueezle@gmail.com>
Date: Mon, 5 Nov 2018 16:46:47 +0000
Subject: [PATCH] docs: add missing docstring for Client#userUpdate (#2930)

* docs: add missing docstring for Client#userUpdate

* docs: indentn't

* docs: indentn't 2
---
 src/client/actions/UserUpdate.js | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/client/actions/UserUpdate.js b/src/client/actions/UserUpdate.js
index 60adc1746..b9c097488 100644
--- a/src/client/actions/UserUpdate.js
+++ b/src/client/actions/UserUpdate.js
@@ -9,6 +9,12 @@ class UserUpdateAction extends Action {
     const oldUser = newUser._update(data.user);
 
     if (!oldUser.equals(newUser)) {
+      /**
+       * Emitted whenever a user's details (e.g. username) are changed.
+       * @event Client#userUpdate
+       * @param {User} oldUser The user before the update
+       * @param {User} newUser The user after the update
+       */
       client.emit(Events.USER_UPDATE, oldUser, newUser);
       return {
         old: oldUser,