docs: consistency

This commit is contained in:
Lewdcario
2018-04-29 13:28:12 -05:00
parent 5acf4061e8
commit 745669a7c9
8 changed files with 18 additions and 22 deletions

View File

@@ -18,7 +18,7 @@
</div>
## About
discord.js is a powerful [node.js](https://nodejs.org) module that allows you to interact with the
discord.js is a powerful [Node.js](https://nodejs.org) module that allows you to interact with the
[Discord API](https://discordapp.com/developers/docs/intro) very easily.
- Object-oriented

View File

@@ -146,9 +146,7 @@ class Shard extends EventEmitter {
* @returns {Promise<*>}
* @example
* shard.fetchClientValue('guilds.size')
* .then(count => {
* console.log(`${count} guilds in shard ${shard.id}`);
* })
* .then(count => console.log(`${count} guilds in shard ${shard.id}`))
* .catch(console.error);
*/
fetchClientValue(prop) {

View File

@@ -56,9 +56,7 @@ class ShardClientUtil {
* @returns {Promise<Array<*>>}
* @example
* client.shard.fetchClientValues('guilds.size')
* .then(results => {
* console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`);
* })
* .then(results => console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`))
* .catch(console.error);
* @see {@link ShardingManager#fetchClientValues}
*/
@@ -82,6 +80,10 @@ class ShardClientUtil {
* Evaluates a script or function on all shards, in the context of the {@link Clients}.
* @param {string|Function} script JavaScript to run on each shard
* @returns {Promise<Array<*>>} Results of the script execution
* @example
* client.shard.broadcastEval('this.guilds.size')
* .then(results => console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`))
* .catch(console.error);
* @see {@link ShardingManager#broadcastEval}
*/
broadcastEval(script) {

View File

@@ -166,9 +166,7 @@ class ShardingManager extends EventEmitter {
* @returns {Promise<Array<*>>}
* @example
* manager.fetchClientValues('guilds.size')
* .then(results => {
* console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`);
* })
* .then(results => console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`))
* .catch(console.error);
*/
fetchClientValues(prop) {

View File

@@ -87,7 +87,7 @@ class GuildMemberStore extends DataStore {
* .catch(console.error);
* @example
* // Fetch by query
* guild.members.fetch({ query: 'hydra' })
* guild.members.fetch({ query: 'hydra', limit: 1 })
* .then(console.log)
* .catch(console.error);
*/

View File

@@ -558,8 +558,8 @@ class GuildChannel extends Channel {
* @example
* // Delete the channel
* channel.delete('making room for new channels')
* .then() // Success
* .catch(console.error); // Log error
* .then(console.log)
* .catch(console.error);
*/
delete(reason) {
return this.client.api.channels(this.id).delete({ reason }).then(() => this);

View File

@@ -125,8 +125,7 @@ class Webhook {
* .then(console.log)
* .catch(console.error);
*/
/* eslint-enable max-len */
async send(content, options) { // eslint-disable-line complexity
async send(content, options) {
if (!options && typeof content === 'object' && !(content instanceof Array)) {
options = content;
content = null;

View File

@@ -125,13 +125,12 @@ class TextBasedChannel {
* @param {MessageSearchOptions} [options={}] Options to pass to the search
* @returns {Promise<MessageSearchResult>}
* @example
* channel.search({
* content: 'discord.js',
* before: '2016-11-17'
* }).then(res => {
* const hit = res.results[0].find(m => m.hit).content;
* console.log(`I found: **${hit}**, total results: ${res.total}`);
* }).catch(console.error);
* channel.search({ content: 'discord.js', before: '2016-11-17' })
* .then(res => {
* const hit = res.results[0].find(m => m.hit).content;
* console.log(`I found: **${hit}**, total results: ${res.total}`);
* })
* .catch(console.error);
*/
search(options = {}) {
return Shared.search(this, options);