Skip to content

Commit d3ee092

Browse files
committed
fix docs strings
1 parent 433471e commit d3ee092

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

firebase_admin/firestore.py

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,18 @@ def client(app: Optional[App] = None, database_id: Optional[str] = None) -> fire
4242
"""Returns a client that can be used to interact with Google Cloud Firestore.
4343
4444
Args:
45-
app: An App instance (optional).
46-
database_id: The database ID of the Google Cloud Firestore database to be used.
47-
Defaults to the default firestore database if not specified or empty string (optional).
45+
app: An App instance (optional).
46+
database_id: The database ID of the Google Cloud Firestore database to be used.
47+
Defaults to the default Firestore database ID if not specified or an empty string
48+
(optional).
4849
4950
Returns:
50-
google.cloud.firestore.Firestore: A `Firestore Client`_.
51+
google.cloud.firestore.Firestore: A `Firestore Client`_.
5152
5253
Raises:
53-
ValueError: If the database ID is not None or a string or a project ID is not specified
54-
either via options, credentials or environment variables, or if the specified
55-
project ID is not a valid string.
54+
ValueError: If the specified database ID is not a valid string, or if a project ID is not
55+
specified either via options, credentials or environment variables, or if the specified
56+
project ID is not a valid string.
5657
5758
.. _Firestore Client: https://cloud.google.com/python/docs/reference/firestore/latest/\
5859
google.cloud.firestore_v1.client.Client

firebase_admin/firestore_async.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,15 @@ def client(app: Optional[App] = None, database_id: Optional[str] = None) -> fire
4444
Args:
4545
app: An App instance (optional).
4646
database_id: The database ID of the Google Cloud Firestore database to be used.
47-
Defaults to the default firestore database if not specified or empty string (optional).
47+
Defaults to the default Firestore database ID if not specified or an empty string
48+
(optional).
4849
4950
Returns:
5051
google.cloud.firestore.Firestore_Async: A `Firestore Async Client`_.
5152
5253
Raises:
53-
ValueError: If the database ID is not None or a string or a project ID is not specified
54-
either via options, credentials or environment variables, or if the specified
54+
ValueError: If the specified database ID is not a valid string, or if a project ID is not
55+
specified either via options, credentials or environment variables, or if the specified
5556
project ID is not a valid string.
5657
5758
.. _Firestore Async Client: https://cloud.google.com/python/docs/reference/firestore/latest/\

0 commit comments

Comments
 (0)