docs: Add/normalize .toString() docs on all classes (#2042)

* docs: Add/normalize .toString() examples on all classes

* docs: Remove exclamation point on ClientApplication#toString example

* docs: Normalize .toString() descriptions on all classes

* Use "returns" instead of "concatenates"
This commit is contained in:
Sanctuary
2017-10-28 14:06:26 -03:00
committed by Crawl
parent 0101392334
commit 1a8e8c7a67
10 changed files with 28 additions and 25 deletions

View File

@@ -332,8 +332,11 @@ class Role extends Base {
}
/**
* When concatenated with a string, this automatically concatenates the role mention rather than the Role object.
* When concatenated with a string, this automatically returns the role's mention instead of the Role object.
* @returns {string}
* @example
* // Logs: Role: <@&123456789012345678>
* console.log(`Role: ${role}`);
*/
toString() {
if (this.id === this.guild.id) return '@everyone';