From 0cc108f0cf5f029aba3bf7ac07c70d9c8bbbd0a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Skar=C5=BCy=C5=84ski?= Date: Tue, 6 Jul 2021 14:14:01 +0200 Subject: [PATCH] correct kwargs documentation in docstrings --- firebase_admin/_auth_client.py | 4 ++-- firebase_admin/_http_client.py | 2 +- firebase_admin/_messaging_utils.py | 2 +- firebase_admin/auth.py | 4 ++-- firebase_admin/db.py | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/firebase_admin/_auth_client.py b/firebase_admin/_auth_client.py index a58dbef74..aae48216c 100644 --- a/firebase_admin/_auth_client.py +++ b/firebase_admin/_auth_client.py @@ -284,7 +284,7 @@ def create_user(self, **kwargs): # pylint: disable=differing-param-doc """Creates a new user account with the specified properties. Args: - kwargs: A series of keyword arguments (optional). + **kwargs: A series of keyword arguments (optional). Keyword Args: uid: User ID to assign to the newly created user (optional). @@ -312,7 +312,7 @@ def update_user(self, uid, **kwargs): # pylint: disable=differing-param-doc Args: uid: A user ID string. - kwargs: A series of keyword arguments (optional). + **kwargs: A series of keyword arguments (optional). Keyword Args: display_name: The user's display name (optional). Can be removed by explicitly passing diff --git a/firebase_admin/_http_client.py b/firebase_admin/_http_client.py index ae312095b..d259faddf 100644 --- a/firebase_admin/_http_client.py +++ b/firebase_admin/_http_client.py @@ -104,7 +104,7 @@ class call this method to send HTTP requests out. Refer to Args: method: HTTP method name as a string (e.g. get, post). url: URL of the remote endpoint. - kwargs: An additional set of keyword arguments to be passed into the requests API + **kwargs: An additional set of keyword arguments to be passed into the requests API (e.g. json, params, timeout). Returns: diff --git a/firebase_admin/_messaging_utils.py b/firebase_admin/_messaging_utils.py index d25ba5520..64930f1b8 100644 --- a/firebase_admin/_messaging_utils.py +++ b/firebase_admin/_messaging_utils.py @@ -341,7 +341,7 @@ class APNSPayload: Args: aps: A ``messaging.Aps`` instance to be included in the payload. - kwargs: Arbitrary keyword arguments to be included as custom fields in the payload + **kwargs: Arbitrary keyword arguments to be included as custom fields in the payload (optional). """ diff --git a/firebase_admin/auth.py b/firebase_admin/auth.py index ed9829aca..992586fa8 100644 --- a/firebase_admin/auth.py +++ b/firebase_admin/auth.py @@ -407,7 +407,7 @@ def create_user(**kwargs): # pylint: disable=differing-param-doc """Creates a new user account with the specified properties. Args: - kwargs: A series of keyword arguments (optional). + **kwargs: A series of keyword arguments (optional). Keyword Args: uid: User ID to assign to the newly created user (optional). @@ -438,7 +438,7 @@ def update_user(uid, **kwargs): # pylint: disable=differing-param-doc Args: uid: A user ID string. - kwargs: A series of keyword arguments (optional). + **kwargs: A series of keyword arguments (optional). Keyword Args: display_name: The user's display name (optional). Can be removed by explicitly passing diff --git a/firebase_admin/db.py b/firebase_admin/db.py index 1d293bb89..890968796 100644 --- a/firebase_admin/db.py +++ b/firebase_admin/db.py @@ -907,7 +907,7 @@ def request(self, method, url, **kwargs): Args: method: HTTP method name as a string (e.g. get, post). url: URL path of the remote endpoint. This will be appended to the server's base URL. - kwargs: An additional set of keyword arguments to be passed into requests API + **kwargs: An additional set of keyword arguments to be passed into requests API (e.g. json, params). Returns: