docs: wording improvements

This commit is contained in:
Lewdcario
2018-06-11 16:37:34 -05:00
parent bce9a8af1b
commit 5eff360a4d
4 changed files with 5 additions and 5 deletions

View File

@@ -435,7 +435,7 @@ class Client extends BaseClient {
* @param {ClientOptions} [options=this.options] Options to validate
* @private
*/
_validateOptions(options = this.options) {
_validateOptions(options = this.options) { // eslint-disable-line complexity
if (typeof options.shardCount !== 'number' || isNaN(options.shardCount)) {
throw new TypeError('CLIENT_INVALID_OPTION', 'shardCount', 'a number');
}

View File

@@ -14,7 +14,7 @@ class GuildMemberUpdateHandler extends AbstractHandler {
const old = member._update(data);
if (client.ws.connection.status === Status.READY) {
/**
* Emitted whenever a guild member changes - i.e. new role, removed role, nickname.
* Emitted whenever a guild member's details (e.g. role, nickname) is changed
* @event Client#guildMemberUpdate
* @param {GuildMember} oldMember The member before the update
* @param {GuildMember} newMember The member after the update

View File

@@ -52,14 +52,14 @@ class PresenceUpdateHandler extends AbstractHandler {
}
/**
* Emitted whenever a guild member's presence changes, or they change one of their details.
* Emitted whenever a guild member's presence (e.g. status, activity) is changed.
* @event Client#presenceUpdate
* @param {GuildMember} oldMember The member before the presence update
* @param {GuildMember} newMember The member after the presence update
*/
/**
* Emitted whenever a user's details (e.g. username) are changed.
* Emitted whenever a user's details (e.g. username, avatar) is changed.
* <info>Disabling {@link Client#presenceUpdate} will cause this event to only fire
* on {@link ClientUser} update.</info>
* @event Client#userUpdate

View File

@@ -58,7 +58,7 @@ const Targets = {
* * INVITE_DELETE: 42
* * WEBHOOK_CREATE: 50
* * WEBHOOK_UPDATE: 51
* * WEBHOOK_DELETE: 50
* * WEBHOOK_DELETE: 52
* * EMOJI_CREATE: 60
* * EMOJI_UPDATE: 61
* * EMOJI_DELETE: 62