Skip to content

Commit e9c78e2

Browse files
authored
Minor API doc updates (#100)
1 parent 8f7c906 commit e9c78e2

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

firebase_admin/auth.py

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -265,18 +265,18 @@ def update_user(uid, **kwargs):
265265
def set_custom_user_claims(uid, custom_claims, app=None):
266266
"""Sets additional claims on an existing user account.
267267
268-
Custom claims set via this function can be used to define user roles and privilege levels.
269-
These claims propagate to all the devices where the user is already signed in (after token
270-
expiration or when token refresh is forced), and next time the user signs in. The claims
271-
can be accessed via the user's ID token JWT. If a reserved OIDC claim is specified (sub, iat,
272-
iss, etc), an error is thrown. Claims payload must also not be larger then 1000 characters
273-
when serialized into a JSON string.
274-
275-
Args:
276-
uid: A user ID string.
277-
custom_claims: A dictionary or a JSON string of custom claims. Pass None to unset any
278-
claims set previously.
279-
app: An App instance (optional).
268+
Custom claims set via this function can be used to define user roles and privilege levels.
269+
These claims propagate to all the devices where the user is already signed in (after token
270+
expiration or when token refresh is forced), and next time the user signs in. The claims
271+
can be accessed via the user's ID token JWT. If a reserved OIDC claim is specified (sub, iat,
272+
iss, etc), an error is thrown. Claims payload must also not be larger then 1000 characters
273+
when serialized into a JSON string.
274+
275+
Args:
276+
uid: A user ID string.
277+
custom_claims: A dictionary or a JSON string of custom claims. Pass None to unset any
278+
claims set previously.
279+
app: An App instance (optional).
280280
281281
Raises:
282282
ValueError: If the specified user ID or the custom claims are invalid.
@@ -497,9 +497,9 @@ def password_hash(self):
497497
"""The user's password hash as a base64-encoded string.
498498
499499
If the Firebase Auth hashing algorithm (SCRYPT) was used to create the user account, this
500-
will be the base64-encoded password hash of the user. If a different hashing algorithm was
500+
is the base64-encoded password hash of the user. If a different hashing algorithm was
501501
used to create this user, as is typical when migrating from another Auth system, this
502-
will be an empty string. If no password is set, this will be None.
502+
is an empty string. If no password is set, this is ``None``.
503503
"""
504504
return self._data.get('passwordHash')
505505

@@ -508,9 +508,9 @@ def password_salt(self):
508508
"""The user's password salt as a base64-encoded string.
509509
510510
If the Firebase Auth hashing algorithm (SCRYPT) was used to create the user account, this
511-
will be the base64-encoded password salt of the user. If a different hashing algorithm was
512-
used to create this user, as is typical when migrating from another Auth system, this will
513-
be an empty string. If no password is set, this will be None.
511+
is the base64-encoded password salt of the user. If a different hashing algorithm was
512+
used to create this user, as is typical when migrating from another Auth system, this is
513+
an empty string. If no password is set, this is ``None``.
514514
"""
515515
return self._data.get('salt')
516516

firebase_admin/db.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@ def start_at(self, start):
442442
Query: The updated Query instance.
443443
444444
Raises:
445-
ValueError: If the value is None.
445+
ValueError: If the value is ``None``.
446446
"""
447447
if start is None:
448448
raise ValueError('Start value must not be None.')
@@ -462,7 +462,7 @@ def end_at(self, end):
462462
Query: The updated Query instance.
463463
464464
Raises:
465-
ValueError: If the value is None.
465+
ValueError: If the value is ``None``.
466466
"""
467467
if end is None:
468468
raise ValueError('End value must not be None.')
@@ -481,7 +481,7 @@ def equal_to(self, value):
481481
Query: The updated Query instance.
482482
483483
Raises:
484-
ValueError: If the value is None.
484+
ValueError: If the value is ``None``.
485485
"""
486486
if value is None:
487487
raise ValueError('Equal to value must not be None.')

0 commit comments

Comments
 (0)