Skip to content

Commit 142a452

Browse files
author
RTLcoil
authored
Fix docstring for pending parameter of the users method (#436)
1 parent e381631 commit 142a452

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

lib-es5/provisioning/account.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ function user(user_id) {
138138

139139
/**
140140
* @desc Lists users in the account.
141-
* @param [pending] {boolean} - Whether to only return pending users. Default: false (all users)
141+
* @param [pending] {boolean} - Limit results to pending users (true), users that are not pending (false), or all users (undefined, the default)
142142
* @param [user_ids] {string[]} - A list of up to 100 user IDs. When provided, other parameters are ignored.
143143
* @param [prefix] {string} - Returns users where the name or email address begins with the specified case-insensitive
144144
* string.

lib/provisioning/account.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ function user(user_id, options = {}, callback) {
117117

118118
/**
119119
* @desc Lists users in the account.
120-
* @param [pending] {boolean} - Whether to only return pending users. Default: false (all users)
120+
* @param [pending] {boolean} - Limit results to pending users (true), users that are not pending (false), or all users (undefined, the default)
121121
* @param [user_ids] {string[]} - A list of up to 100 user IDs. When provided, other parameters are ignored.
122122
* @param [prefix] {string} - Returns users where the name or email address begins with the specified case-insensitive
123123
* string.

0 commit comments

Comments
 (0)