From 2ace21c412afba6f8e56ecdafffd5d5d82708fb8 Mon Sep 17 00:00:00 2001 From: Amish Shah Date: Mon, 1 May 2017 15:10:11 +0100 Subject: [PATCH] backwards compat docs --- src/structures/Guild.js | 3 ++- src/structures/GuildMember.js | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/src/structures/Guild.js b/src/structures/Guild.js index f00f4dadf..bbb74624f 100644 --- a/src/structures/Guild.js +++ b/src/structures/Guild.js @@ -668,7 +668,8 @@ class Guild { /** * Bans a user from the guild. * @param {UserResolvable} user The user to ban - * @param {Object} [options] Ban options. + * @param {Object|number|string} [options] Ban options. If a number, the number of days to delete messages for, if a + * string, the ban reason. Supplying an object allows you to do both. * @param {number} [options.days=0] Number of days of messages to delete * @param {string} [options.reason] Reason for banning * @returns {Promise} Result object will be resolved as specifically as possible. diff --git a/src/structures/GuildMember.js b/src/structures/GuildMember.js index c3838d165..bcad0e03e 100644 --- a/src/structures/GuildMember.js +++ b/src/structures/GuildMember.js @@ -482,7 +482,8 @@ class GuildMember { /** * Ban this guild member - * @param {Object} [options] Ban options. + * @param {Object|number|string} [options] Ban options. If a number, the number of days to delete messages for, if a + * string, the ban reason. Supplying an object allows you to do both. * @param {number} [options.days=0] Number of days of messages to delete * @param {string} [options.reason] Reason for banning * @returns {Promise}