From 1273bb42ec760b505f9bf93d0bc7ab0846fef383 Mon Sep 17 00:00:00 2001 From: Jamelele Date: Sun, 19 Feb 2017 21:06:18 +0000 Subject: [PATCH] Doc fixes (#1197) * Improve ban/unban examples * Fix example comments * Replace nondescript 'user' parameter with 'some user ID' * Update Guild.js * Update Guild.js --- src/structures/Guild.js | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/src/structures/Guild.js b/src/structures/Guild.js index a39d1adce..99b0b6012 100644 --- a/src/structures/Guild.js +++ b/src/structures/Guild.js @@ -572,8 +572,10 @@ class Guild { * If the GuildMember cannot be resolved, the User will instead be attempted to be resolved. If that also cannot * be resolved, the user ID will be the result. * @example - * // ban a user - * guild.ban('123123123123'); + * // ban a user by ID (or with a user/guild member object) + * guild.ban('some user ID') + * .then(user => console.log(`Banned ${user.username || user.id || user} from ${guild.name}`)) + * .catch(console.error); */ ban(user, deleteDays = 0) { return this.client.rest.methods.banGuildMember(this, user, deleteDays); @@ -584,10 +586,10 @@ class Guild { * @param {UserResolvable} user The user to unban * @returns {Promise} * @example - * // unban a user - * guild.unban('123123123123') + * // unban a user by ID (or with a user/guild member object) + * guild.unban('some user ID') * .then(user => console.log(`Unbanned ${user.username} from ${guild.name}`)) - * .catch(reject); + * .catch(console.error); */ unban(user) { return this.client.rest.methods.unbanGuildMember(this, user);