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

@@ -147,34 +147,35 @@ class RichPresenceAssets {
Object.defineProperty(this, 'activity', { value: activity });
/**
* Hover text for large image
* Hover text for the large image
* @type {?string}
*/
this.largeText = assets.large_text || null;
/**
* Hover text for small image
* Hover text for the small image
* @type {?string}
*/
this.smallText = assets.small_text || null;
/**
* ID of large image asset
* ID of the large image asset
* @type {?string}
*/
this.largeImage = assets.large_image || null;
/**
* ID of small image asset
* ID of the small image asset
* @type {?string}
*/
this.smallImage = assets.small_image || null;
}
/**
* Gets the URL of the small image asset
* @param {string} format Format of the image
* @param {number} size Size of the iamge
* @returns {?string} small image url
* @param {number} size Size of the image
* @returns {?string} The small image URL
*/
smallImageURL({ format, size } = {}) {
if (!this.smallImage) return null;
@@ -183,9 +184,10 @@ class RichPresenceAssets {
}
/**
* Gets the URL of the large image asset
* @param {string} format Format of the image
* @param {number} size Size of the iamge
* @returns {?string} large image url
* @param {number} size Size of the image
* @returns {?string} The large image URL
*/
largeImageURL({ format, size } = {}) {
if (!this.largeImage) return null;