Skip to content

Commit f8b1fff

Browse files
authored
Followup to #400 to ensure all new types are exported (#461)
Also fix multi-line Returns: doc statements. (See sphinx-contrib/napoleon#4)
1 parent d1aae52 commit f8b1fff

File tree

4 files changed

+14
-13
lines changed

4 files changed

+14
-13
lines changed

firebase_admin/_auth_client.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ def get_users(self, identifiers):
200200
201201
Returns:
202202
GetUsersResult: A ``GetUsersResult`` instance corresponding to the
203-
specified identifiers.
203+
specified identifiers.
204204
205205
Raises:
206206
ValueError: If any of the identifiers are invalid or if more than 100
@@ -374,8 +374,8 @@ def delete_users(self, uids):
374374
375375
Returns:
376376
DeleteUsersResult: The total number of successful/failed deletions, as
377-
well as the array of errors that correspond to the failed
378-
deletions.
377+
well as the array of errors that correspond to the failed
378+
deletions.
379379
380380
Raises:
381381
ValueError: If any of the identifiers are invalid or if more than 1000

firebase_admin/_auth_providers.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ def get_next_page(self):
121121
122122
Returns:
123123
ListProviderConfigsPage: Next page of provider configs, or None if this is the last
124-
page.
124+
page.
125125
"""
126126
if self.has_next_page:
127127
return self.__class__(self._download, self.next_page_token, self._max_results)

firebase_admin/_user_mgt.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ def last_refresh_timestamp(self):
7878
7979
Returns:
8080
integer: Milliseconds since epoch timestamp, or `None` if the user was
81-
never active.
81+
never active.
8282
"""
8383
return self._last_refresh_timestamp
8484

@@ -215,7 +215,7 @@ def tokens_valid_after_timestamp(self):
215215
216216
Returns:
217217
int: Timestamp in milliseconds since the epoch, truncated to the second.
218-
All tokens issued before that time are considered revoked.
218+
All tokens issued before that time are considered revoked.
219219
"""
220220
valid_since = self._data.get('validSince')
221221
if valid_since is not None:
@@ -752,7 +752,7 @@ def delete_users(self, uids, force_delete=False):
752752
753753
Returns:
754754
BatchDeleteAccountsResponse: Server's proto response, wrapped in a
755-
python object.
755+
python object.
756756
757757
Raises:
758758
ValueError: If any of the identifiers are invalid or if more than 1000

firebase_admin/auth.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@
4343
'ExpiredIdTokenError',
4444
'ExpiredSessionCookieError',
4545
'ExportedUserRecord',
46+
'DeleteUsersResult',
47+
'GetUsersResult',
4648
'ImportUserRecord',
4749
'InsufficientPermissionError',
4850
'InvalidDynamicLinkDomainError',
@@ -356,14 +358,14 @@ def get_users(identifiers, app=None):
356358
identifiers are supplied, this method raises a `ValueError`.
357359
358360
Args:
359-
identifiers (list[Identifier]): A list of ``Identifier`` instances used
360-
to indicate which user records should be returned. Must have <= 100
361-
entries.
361+
identifiers (list[UserIdentifier]): A list of ``UserIdentifier``
362+
instances used to indicate which user records should be returned.
363+
Must have <= 100 entries.
362364
app: An App instance (optional).
363365
364366
Returns:
365367
GetUsersResult: A ``GetUsersResult`` instance corresponding to the
366-
specified identifiers.
368+
specified identifiers.
367369
368370
Raises:
369371
ValueError: If any of the identifiers are invalid or if more than 100
@@ -522,8 +524,7 @@ def delete_users(uids, app=None):
522524
523525
Returns:
524526
DeleteUsersResult: The total number of successful/failed deletions, as
525-
well as the array of errors that correspond to the failed
526-
deletions.
527+
well as the array of errors that correspond to the failed deletions.
527528
528529
Raises:
529530
ValueError: If any of the identifiers are invalid or if more than 1000

0 commit comments

Comments
 (0)