work on docs

This commit is contained in:
Amish Shah
2016-08-18 10:13:00 +01:00
parent 55630a38ac
commit 46e89f56c7
2 changed files with 5 additions and 4 deletions

File diff suppressed because one or more lines are too long

View File

@@ -29,11 +29,12 @@ class Client extends EventEmitter {
}
/**
* Logs the client in. If successful, resolves with the account's token.
* @param {string} emailOrToken The email or token used for the account. If it is an email, a password _must_ be
* provided. <warn>If you're making a bot, it's much better to use a bot account rather than a user account.
* Logs the client in. If successful, resolves with the account's token. <warn>If you're making a bot, it's
* much better to use a bot account rather than a user account.
* Bot accounts have higher rate limits and have access to some features user accounts don't have. User bots
* that are making a lot of API requests can even be banned.</warn>
* @param {string} emailOrToken The email or token used for the account. If it is an email, a password _must_ be
* provided.
* @param {string} [password] The password for the account, only needed if an email was provided.
* @return {Promise<String>}
* @example