Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-10 08:33:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs a bit

Browse Source
This commit is contained in:
Crawl
2017-04-30 04:30:44 +02:00
parent 3f8c0a4d11
commit ac92d2cecc
83 changed files with 716 additions and 711 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/structures/ClientUserSettings.js
View File

@@ -2,7 +2,7 @@ const Constants = require('../util/Constants');
const Util = require('../util/Util');
/**
* A wrapper around the ClientUser's settings
* A wrapper around the ClientUser's settings.
*/
class ClientUserSettings {
constructor(user, data) {
@@ -11,7 +11,7 @@ class ClientUserSettings {
}
/**
* Patch the data contained in this class with new partial data
* Patch the data contained in this class with new partial data.
* @param {Object} data Data to patch this with
*/
patch(data) {
@@ -27,7 +27,7 @@ class ClientUserSettings {
}
/**
* Update a specific property of of user settings
* Update a specific property of of user settings.
* @param {string} name Name of property
* @param {value} value Value to patch
* @returns {Promise<Object>}
@@ -37,7 +37,7 @@ class ClientUserSettings {
}
/**
* @param {Guild} guild Guild to move
* @param {Guild} guild The guild to move
* @param {number} position Absolute or relative position
* @param {boolean} [relative=false] Whether to position relatively or absolutely
* @returns {Promise<Guild>}
@@ -49,8 +49,8 @@ class ClientUserSettings {
}
/**
* Add a guild to the list of restricted guilds
* @param {Guild} guild Guild to add
* Add a guild to the list of restricted guilds.
* @param {Guild} guild The guild to add
* @returns {Promise<Guild>}
*/
addRestrictedGuild(guild) {
@@ -61,8 +61,8 @@ class ClientUserSettings {
}
/**
* Remove a guild from the list of restricted guilds
* @param {Guild} guild Guild to remove
* Remove a guild from the list of restricted guilds.
* @param {Guild} guild The guild to remove
* @returns {Promise<Guild>}
*/
removeRestrictedGuild(guild) {