docs(MessageMentionTypes): move possible values to description (#3990)

* docs(MessageMentionTypes): correct type

* docs(MessageMentionTypes): change role to roles

* docs(MessageMentionOptions): correct description to allow usage as an array

* remove unneeded part of description

Co-Authored-By: Ryan Munro <rsm999@uowmail.edu.au>

* docs: add DisableMentionType to remove literal string types

Co-authored-by: Ryan Munro <rsm999@uowmail.edu.au>
This commit is contained in:
Jyguy
2020-03-27 15:54:27 -04:00
committed by GitHub
parent 51ff5ddb64
commit fee9a218e8
3 changed files with 18 additions and 8 deletions

View File

@@ -21,8 +21,7 @@ const browser = (exports.browser = typeof window !== 'undefined');
* the message cache lifetime (in seconds, 0 for never)
* @property {boolean} [fetchAllMembers=false] Whether to cache all guild members and users upon startup, as well as
* upon joining a guild (should be avoided whenever possible)
* @property {'none' | 'all' | 'everyone'} [disableMentions='none'] Default value
* for {@link MessageOptions#disableMentions}
* @property {DisableMentionType} [disableMentions='none'] Default value for {@link MessageOptions#disableMentions}
* @property {PartialType[]} [partials] Structures allowed to be partial. This means events can be emitted even when
* they're missing all the data for a particular structure. See the "Partials" topic listed in the sidebar for some
* important usage information, as partials require you to put checks in place when handling data.