Typos in docs (#2055)

* Typo in Guild.createRole docs

Added missing semicolon in example code.

* consistent periods in docs
This commit is contained in:
William Tran
2017-10-28 10:01:17 -07:00
committed by Crawl
parent c495ea025a
commit 88719f0f42
3 changed files with 4 additions and 4 deletions

View File

@@ -236,7 +236,7 @@ class VoiceBroadcast extends VolumeInterface {
} }
/** /**
* Plays an arbitrary input that can be [handled by ffmpeg](https://ffmpeg.org/ffmpeg-protocols.html#Description) * Plays an arbitrary input that can be [handled by ffmpeg](https://ffmpeg.org/ffmpeg-protocols.html#Description).
* @param {string} input The arbitrary input * @param {string} input The arbitrary input
* @param {StreamOptions} [options] Options for playing the stream * @param {StreamOptions} [options] Options for playing the stream
* @returns {VoiceBroadcast} * @returns {VoiceBroadcast}

View File

@@ -979,7 +979,7 @@ class Guild extends Base {
} }
/** /**
* Creates a new role in the guild with given information * Creates a new role in the guild with given information.
* <warn>The position will silently reset to 1 if an invalid one is provided, or none.</warn> * <warn>The position will silently reset to 1 if an invalid one is provided, or none.</warn>
* @param {Object} [options] Options * @param {Object} [options] Options
* @param {RoleData} [options.data] The data to update the role with * @param {RoleData} [options.data] The data to update the role with
@@ -1000,7 +1000,7 @@ class Guild extends Base {
* reason: 'we needed a role for Super Cool People', * reason: 'we needed a role for Super Cool People',
* }) * })
* .then(role => console.log(`Created role ${role}`)) * .then(role => console.log(`Created role ${role}`))
* .catch(console.error) * .catch(console.error);
*/ */
createRole({ data = {}, reason } = {}) { createRole({ data = {}, reason } = {}) {
if (data.color) data.color = Util.resolveColor(data.color); if (data.color) data.color = Util.resolveColor(data.color);

View File

@@ -38,7 +38,7 @@ class Presence {
} }
/** /**
* Whether this presence is equal to another * Whether this presence is equal to another.
* @param {Presence} presence The presence to compare with * @param {Presence} presence The presence to compare with
* @returns {boolean} * @returns {boolean}
*/ */