Grammar cleanup (#875)

This commit:
* fixes inconsistencies (primarily regarding capitalization)
* fixes non-proper nouns that were improperly capitalized
* fixes reminents from not-so-meticulous copy+paste jobs
This commit is contained in:
Programmix
2016-11-05 16:57:34 -07:00
committed by Amish Shah
parent 93e6c69bd1
commit fe3914658a
37 changed files with 151 additions and 150 deletions

View File

@@ -90,25 +90,25 @@ class Client extends EventEmitter {
this.shard = process.send ? ShardClientUtil.singleton(this) : null;
/**
* A Collection of the Client's stored users
* A collection of the Client's stored users
* @type {Collection<string, User>}
*/
this.users = new Collection();
/**
* A Collection of the Client's stored guilds
* A collection of the Client's stored guilds
* @type {Collection<string, Guild>}
*/
this.guilds = new Collection();
/**
* A Collection of the Client's stored channels
* A collection of the Client's stored channels
* @type {Collection<string, Channel>}
*/
this.channels = new Collection();
/**
* A Collection of presences for friends of the logged in user.
* A collection of presences for friends of the logged in user.
* <warn>This is only filled for user accounts, not bot accounts.</warn>
* @type {Collection<string, Presence>}
*/
@@ -175,7 +175,7 @@ class Client extends EventEmitter {
}
/**
* Returns a Collection, mapping Guild ID to Voice Connections.
* Returns a collection, mapping guild ID to voice connections.
* @type {Collection<string, VoiceConnection>}
* @readonly
*/
@@ -246,7 +246,7 @@ class Client extends EventEmitter {
/**
* This shouldn't really be necessary to most developers as it is automatically invoked every 30 seconds, however
* if you wish to force a sync of Guild data, you can use this.
* if you wish to force a sync of guild data, you can use this.
* <warn>This is only applicable to user accounts.</warn>
* @param {Guild[]|Collection<string, Guild>} [guilds=this.guilds] An array or collection of guilds to sync
*/

View File

@@ -24,7 +24,7 @@ class ClientDataManager {
this.client.guilds.set(guild.id, guild);
if (this.pastReady && !already) {
/**
* Emitted whenever the client joins a Guild.
* Emitted whenever the client joins a guild.
* @event Client#guildCreate
* @param {Guild} guild The created guild
*/

View File

@@ -25,10 +25,10 @@ class ClientDataResolver {
/**
* Data that resolves to give a User object. This can be:
* * A User object
* * A User ID
* * A Message (resolves to the message author)
* * A Guild (owner of the guild)
* * A Guild Member
* * A user ID
* * A Message object (resolves to the message author)
* * A Guild object (owner of the guild)
* * A GuildMember object
* @typedef {User|string|Message|Guild|GuildMember} UserResolvable
*/
@@ -99,10 +99,10 @@ class ClientDataResolver {
/**
* Data that can be resolved to give a Channel. This can be:
* * An instance of a Channel
* * An instance of a Message (the channel the message was sent in)
* * An instance of a Guild (the #general channel)
* * An ID of a Channel
* * A Channel object
* * A Message object (the channel the message was sent in)
* * A Guild object (the #general channel)
* * A channel ID
* @typedef {Channel|Guild|Message|string} ChannelResolvable
*/
@@ -190,7 +190,7 @@ class ClientDataResolver {
/**
* Data that can be resolved to give a string. This can be:
* * A string
* * An Array (joined with a new line delimiter to give a string)
* * An array (joined with a new line delimiter to give a string)
* * Any value
* @typedef {string|Array|*} StringResolvable
*/
@@ -209,7 +209,7 @@ class ClientDataResolver {
/**
* Data that resolves to give a Base64 string, typically for image uploading. This can be:
* * A Buffer
* * A Base64 string
* * A base64 string
* @typedef {Buffer|string} Base64Resolvable
*/

View File

@@ -23,7 +23,7 @@ class ClientVoiceManager {
this.connections = new Collection();
/**
* Pending connection attempts, maps Guild ID to VoiceChannel
* Pending connection attempts, maps guild ID to VoiceChannel
* @type {Collection<string, VoiceChannel>}
*/
this.pending = new Collection();

View File

@@ -7,7 +7,7 @@ const EventEmitter = require('events').EventEmitter;
const fs = require('fs');
/**
* Represents a connection to a Voice Channel in Discord.
* Represents a connection to a voice channel in Discord.
* ```js
* // obtained using:
* voiceChannel.join().then(connection => {

View File

@@ -9,7 +9,7 @@ class ChannelCreateHandler extends AbstractHandler {
}
/**
* Emitted whenever a Channel is created.
* Emitted whenever a channel is created.
* @event Client#channelCreate
* @param {Channel} channel The channel that was created
*/

View File

@@ -12,7 +12,7 @@ class ChannelDeleteHandler extends AbstractHandler {
}
/**
* Emitted whenever a Channel is deleted.
* Emitted whenever a channel is deleted.
* @event Client#channelDelete
* @param {Channel} channel The channel that was deleted
*/

View File

@@ -21,7 +21,7 @@ class ChannelPinsUpdate extends AbstractHandler {
}
/**
* Emitted whenever the pins of a Channel are updated. Due to the nature of the WebSocket event, not much information
* Emitted whenever the pins of a channel are updated. Due to the nature of the WebSocket event, not much information
* can be provided easily here - you need to manually check the pins yourself.
* @event Client#channelPinsUpdate
* @param {Channel} channel The channel that the pins update occured in

View File

@@ -11,7 +11,7 @@ class GuildDeleteHandler extends AbstractHandler {
}
/**
* Emitted whenever a Guild is deleted/left.
* Emitted whenever a guild is deleted/left.
* @event Client#guildDelete
* @param {Guild} guild The guild that was deleted
*/

View File

@@ -20,7 +20,7 @@ class GuildMembersChunkHandler extends AbstractHandler {
}
/**
* Emitted whenever a chunk of Guild members is received (all members come from the same guild)
* Emitted whenever a chunk of guild members is received (all members come from the same guild)
* @event Client#guildMembersChunk
* @param {GuildMember[]} members The members in the chunk
*/

View File

@@ -64,7 +64,7 @@ class PresenceUpdateHandler extends AbstractHandler {
*/
/**
* Emitted whenever a member becomes available in a large Guild
* Emitted whenever a member becomes available in a large guild
* @event Client#guildMemberAvailable
* @param {GuildMember} member The member that became available
*/