From 3e3de51545a0047b6bcb05bd923bd35029aff602 Mon Sep 17 00:00:00 2001 From: Schuyler Cebulskie Date: Thu, 29 Dec 2016 11:01:27 -0500 Subject: [PATCH] Update message sending docs --- src/structures/interface/TextBasedChannel.js | 28 ++++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/src/structures/interface/TextBasedChannel.js b/src/structures/interface/TextBasedChannel.js index 7d078816e..353c0a9cf 100644 --- a/src/structures/interface/TextBasedChannel.js +++ b/src/structures/interface/TextBasedChannel.js @@ -55,8 +55,8 @@ class TextBasedChannel { /** * Send a message to this channel - * @param {StringResolvable} [content] The content to send - * @param {MessageOptions} [options={}] The options to provide + * @param {StringResolvable} [content] Text for the message + * @param {MessageOptions} [options={}] Options for the message * @returns {Promise} * @example * // send a message @@ -94,8 +94,8 @@ class TextBasedChannel { /** * Send a message to this channel - * @param {StringResolvable} content The content to send - * @param {MessageOptions} [options={}] The options to provide + * @param {StringResolvable} content Text for the message + * @param {MessageOptions} [options={}] Options for the message * @returns {Promise} * @example * // send a message @@ -109,9 +109,9 @@ class TextBasedChannel { /** * Send an embed to this channel - * @param {RichEmbed|Object} embed The embed to send - * @param {string} [content] Content to send - * @param {MessageOptions} [options] The options to provide + * @param {RichEmbed|Object} embed Embed for the message + * @param {string} [content] Text for the message + * @param {MessageOptions} [options] Options for the message * @returns {Promise} */ sendEmbed(embed, content, options) { @@ -126,10 +126,10 @@ class TextBasedChannel { /** * Send a file to this channel - * @param {BufferResolvable} attachment The file to send - * @param {string} [name='file.jpg'] The name and extension of the file - * @param {StringResolvable} [content] Text message to send with the attachment - * @param {MessageOptions} [options] The options to provide + * @param {BufferResolvable} attachment File to send + * @param {string} [name='file.jpg'] Name and extension of the file + * @param {StringResolvable} [content] Text for the message + * @param {MessageOptions} [options] Options for the message * @returns {Promise} */ sendFile(attachment, name, content, options = {}) { @@ -140,7 +140,7 @@ class TextBasedChannel { * Send a code block to this channel * @param {string} lang Language for the code block * @param {StringResolvable} content Content of the code block - * @param {MessageOptions} [options] The options to provide + * @param {MessageOptions} [options] Options for the message * @returns {Promise} */ sendCode(lang, content, options = {}) { @@ -150,7 +150,7 @@ class TextBasedChannel { /** * Gets a single message from this channel, regardless of it being cached or not. * This is only available when using a bot account. - * @param {string} messageID The ID of the message to get + * @param {string} messageID ID of the message to get * @returns {Promise} * @example * // get message @@ -178,7 +178,7 @@ class TextBasedChannel { /** * Gets the past messages sent in this channel. Resolves with a collection mapping message ID's to Message objects. - * @param {ChannelLogsQueryOptions} [options={}] The query parameters to pass in + * @param {ChannelLogsQueryOptions} [options={}] Query parameters to pass in * @returns {Promise>} * @example * // get messages