Skip to content

Commit 02596dc

Browse files
authored
correct kwargs documentation in docstrings (firebase#559)
1 parent 348a90d commit 02596dc

File tree

5 files changed

+7
-7
lines changed

5 files changed

+7
-7
lines changed

firebase_admin/_auth_client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ def create_user(self, **kwargs): # pylint: disable=differing-param-doc
288288
"""Creates a new user account with the specified properties.
289289
290290
Args:
291-
kwargs: A series of keyword arguments (optional).
291+
**kwargs: A series of keyword arguments (optional).
292292
293293
Keyword Args:
294294
uid: User ID to assign to the newly created user (optional).
@@ -316,7 +316,7 @@ def update_user(self, uid, **kwargs): # pylint: disable=differing-param-doc
316316
317317
Args:
318318
uid: A user ID string.
319-
kwargs: A series of keyword arguments (optional).
319+
**kwargs: A series of keyword arguments (optional).
320320
321321
Keyword Args:
322322
display_name: The user's display name (optional). Can be removed by explicitly passing

firebase_admin/_http_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ class call this method to send HTTP requests out. Refer to
104104
Args:
105105
method: HTTP method name as a string (e.g. get, post).
106106
url: URL of the remote endpoint.
107-
kwargs: An additional set of keyword arguments to be passed into the requests API
107+
**kwargs: An additional set of keyword arguments to be passed into the requests API
108108
(e.g. json, params, timeout).
109109
110110
Returns:

firebase_admin/_messaging_utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ class APNSPayload:
341341
342342
Args:
343343
aps: A ``messaging.Aps`` instance to be included in the payload.
344-
kwargs: Arbitrary keyword arguments to be included as custom fields in the payload
344+
**kwargs: Arbitrary keyword arguments to be included as custom fields in the payload
345345
(optional).
346346
"""
347347

firebase_admin/auth.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@ def create_user(**kwargs): # pylint: disable=differing-param-doc
416416
"""Creates a new user account with the specified properties.
417417
418418
Args:
419-
kwargs: A series of keyword arguments (optional).
419+
**kwargs: A series of keyword arguments (optional).
420420
421421
Keyword Args:
422422
uid: User ID to assign to the newly created user (optional).
@@ -447,7 +447,7 @@ def update_user(uid, **kwargs): # pylint: disable=differing-param-doc
447447
448448
Args:
449449
uid: A user ID string.
450-
kwargs: A series of keyword arguments (optional).
450+
**kwargs: A series of keyword arguments (optional).
451451
452452
Keyword Args:
453453
display_name: The user's display name (optional). Can be removed by explicitly passing

firebase_admin/db.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -907,7 +907,7 @@ def request(self, method, url, **kwargs):
907907
Args:
908908
method: HTTP method name as a string (e.g. get, post).
909909
url: URL path of the remote endpoint. This will be appended to the server's base URL.
910-
kwargs: An additional set of keyword arguments to be passed into requests API
910+
**kwargs: An additional set of keyword arguments to be passed into requests API
911911
(e.g. json, params).
912912
913913
Returns:

0 commit comments

Comments
 (0)