docs(Role): Update various Role method descriptions (#4798)

Co-authored-by: Papaia <43409674+Papaia@users.noreply.github.com>
This commit is contained in:
anandre
2020-09-08 02:58:11 -05:00
committed by GitHub
parent 372a405926
commit 222137dcd1

View File

@@ -173,7 +173,7 @@ class Role extends Base {
* @example
* // Edit a role
* role.edit({ name: 'new role' })
* .then(updated => console.log(`Edited role ${updated.name} name to ${updated.name}`))
* .then(updated => console.log(`Edited role name to ${updated.name}`))
* .catch(console.error);
*/
async edit(data, reason) {
@@ -232,7 +232,7 @@ class Role extends Base {
* @example
* // Set the name of the role
* role.setName('new role')
* .then(updated => console.log(`Edited name of role ${role.name} to ${updated.name}`))
* .then(updated => console.log(`Updated role name to ${updated.name}`))
* .catch(console.error);
*/
setName(name, reason) {
@@ -262,7 +262,7 @@ class Role extends Base {
* @example
* // Set the hoist of the role
* role.setHoist(true)
* .then(r => console.log(`Role hoisted: ${r.hoist}`))
* .then(updated => console.log(`Role hoisted: ${updated.hoist}`))
* .catch(console.error);
*/
setHoist(hoist, reason) {