Various documentation adjustments (#2001)

* docs(various): Add "at" to createdAt description

* docs(Client): Adjust to fit with guilds property

* docs(various): Adjust phrasing & fix typos

* docs(various): Clarifications

* docs(Permissions): fix numerus

* docs(DataStore): capitalize DataStore

* docs(various): Formatting changes

* docs(Presence): Expand RichPresenceAssets docs

* Add space
This commit is contained in:
Robin B
2017-10-07 01:56:17 +02:00
committed by Crawl
parent 8fbae13040
commit 97823bc376
39 changed files with 149 additions and 146 deletions

View File

@@ -77,7 +77,7 @@ class User extends Base {
}
/**
* The time the user was created
* The time the user was created at
* @type {Date}
* @readonly
*/
@@ -134,7 +134,7 @@ class User extends Base {
}
/**
* The Discord "tag" for this user
* The Discord "tag" (e.g. `hydrabolt#0086`) for this user
* @type {string}
* @readonly
*/
@@ -153,7 +153,7 @@ class User extends Base {
}
/**
* Check whether the user is typing in a channel.
* Checks whether the user is typing in a channel.
* @param {ChannelResolvable} channel The channel to check in
* @returns {boolean}
*/
@@ -163,7 +163,7 @@ class User extends Base {
}
/**
* Get the time that the user started typing.
* Gets the time that the user started typing.
* @param {ChannelResolvable} channel The channel to get the time in
* @returns {?Date}
*/
@@ -173,7 +173,7 @@ class User extends Base {
}
/**
* Get the amount of time the user has been typing in a channel for (in milliseconds), or -1 if they're not typing.
* Gets the amount of time the user has been typing in a channel for (in milliseconds), or -1 if they're not typing.
* @param {ChannelResolvable} channel The channel to get the time in
* @returns {number}
*/
@@ -214,7 +214,7 @@ class User extends Base {
}
/**
* Get the profile of the user.
* Gets the profile of the user.
* <warn>This is only available when using a user account.</warn>
* @returns {Promise<UserProfile>}
*/