Skip to content

Commit dc79b20

Browse files
chore(docs): update proto path references (#976)
1 parent aa3c0a3 commit dc79b20

File tree

12 files changed

+26
-26
lines changed

12 files changed

+26
-26
lines changed

google/cloud/firestore_v1/_helpers.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ def get_doc_id(document_pb, expected_prefix) -> str:
414414
"""Parse a document ID from a document protobuf.
415415
416416
Args:
417-
document_pb (google.cloud.proto.firestore.v1.\
417+
document_pb (google.cloud.firestore_v1.\
418418
document.Document): A protobuf for a document that
419419
was created in a ``CreateDocument`` RPC.
420420
expected_prefix (str): The expected collection prefix for the

google/cloud/firestore_v1/async_batch.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ async def commit(
5050
system-specified value.
5151
5252
Returns:
53-
List[:class:`google.cloud.proto.firestore.v1.write.WriteResult`, ...]:
53+
List[:class:`google.cloud.firestore_v1.write.WriteResult`, ...]:
5454
The write results corresponding to the changes committed, returned
5555
in the same order as the changes were applied to this batch. A
5656
write result contains an ``update_time`` field.

google/cloud/firestore_v1/async_query.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,13 @@ class AsyncQuery(BaseQuery):
5959
Args:
6060
parent (:class:`~google.cloud.firestore_v1.collection.CollectionReference`):
6161
The collection that this query applies to.
62-
projection (Optional[:class:`google.cloud.proto.firestore.v1.\
62+
projection (Optional[:class:`google.cloud.firestore_v1.\
6363
query.StructuredQuery.Projection`]):
6464
A projection of document fields to limit the query results to.
65-
field_filters (Optional[Tuple[:class:`google.cloud.proto.firestore.v1.\
65+
field_filters (Optional[Tuple[:class:`google.cloud.firestore_v1.\
6666
query.StructuredQuery.FieldFilter`, ...]]):
6767
The filters to be applied in the query.
68-
orders (Optional[Tuple[:class:`google.cloud.proto.firestore.v1.\
68+
orders (Optional[Tuple[:class:`google.cloud.firestore_v1.\
6969
query.StructuredQuery.Order`, ...]]):
7070
The "order by" entries to use in the query.
7171
limit (Optional[int]):

google/cloud/firestore_v1/async_transaction.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ def _add_write_pbs(self, write_pbs: list) -> None:
6363
"""Add `Write`` protobufs to this transaction.
6464
6565
Args:
66-
write_pbs (List[google.cloud.proto.firestore.v1.\
66+
write_pbs (List[google.cloud.firestore_v1.\
6767
write.Write]): A list of write protobufs to be added.
6868
6969
Raises:
@@ -124,7 +124,7 @@ async def _commit(self) -> list:
124124
"""Transactionally commit the changes accumulated.
125125
126126
Returns:
127-
List[:class:`google.cloud.proto.firestore.v1.write.WriteResult`, ...]:
127+
List[:class:`google.cloud.firestore_v1.write.WriteResult`, ...]:
128128
The write results corresponding to the changes committed, returned
129129
in the same order as the changes were applied to this transaction.
130130
A write result contains an ``update_time`` field.

google/cloud/firestore_v1/base_batch.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def _add_write_pbs(self, write_pbs: list) -> None:
5555
This method intended to be over-ridden by subclasses.
5656
5757
Args:
58-
write_pbs (List[google.cloud.proto.firestore.v1.\
58+
write_pbs (List[google.cloud.firestore_v1.\
5959
write_pb2.Write]): A list of write protobufs to be added.
6060
"""
6161
self._write_pbs.extend(write_pbs)

google/cloud/firestore_v1/base_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -537,7 +537,7 @@ def _parse_batch_get(
537537
"""Parse a `BatchGetDocumentsResponse` protobuf.
538538
539539
Args:
540-
get_doc_response (~google.cloud.proto.firestore.v1.\
540+
get_doc_response (~google.cloud.firestore_v1.\
541541
firestore.BatchGetDocumentsResponse): A single response (from
542542
a stream) containing the "get" response for a document.
543543
reference_map (Dict[str, .DocumentReference]): A mapping (produced

google/cloud/firestore_v1/base_document.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -548,7 +548,7 @@ def _consume_single_get(response_iterator) -> firestore.BatchGetDocumentsRespons
548548
request.
549549
550550
Returns:
551-
~google.cloud.proto.firestore.v1.\
551+
~google.cloud.firestore_v1.\
552552
firestore.BatchGetDocumentsResponse: The single "get"
553553
response in the batch.
554554
@@ -575,7 +575,7 @@ def _first_write_result(write_results: list) -> write.WriteResult:
575575
at the same time).
576576
577577
Args:
578-
write_results (List[google.cloud.proto.firestore.v1.\
578+
write_results (List[google.cloud.firestore_v1.\
579579
write.WriteResult, ...]: The write results from a
580580
``CommitResponse``.
581581

google/cloud/firestore_v1/base_query.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -236,13 +236,13 @@ class BaseQuery(object):
236236
Args:
237237
parent (:class:`~google.cloud.firestore_v1.collection.CollectionReference`):
238238
The collection that this query applies to.
239-
projection (Optional[:class:`google.cloud.proto.firestore.v1.\
239+
projection (Optional[:class:`google.cloud.firestore_v1.\
240240
query.StructuredQuery.Projection`]):
241241
A projection of document fields to limit the query results to.
242-
field_filters (Optional[Tuple[:class:`google.cloud.proto.firestore.v1.\
242+
field_filters (Optional[Tuple[:class:`google.cloud.firestore_v1.\
243243
query.StructuredQuery.FieldFilter`, ...]]):
244244
The filters to be applied in the query.
245-
orders (Optional[Tuple[:class:`google.cloud.proto.firestore.v1.\
245+
orders (Optional[Tuple[:class:`google.cloud.firestore_v1.\
246246
query.StructuredQuery.Order`, ...]]):
247247
The "order by" entries to use in the query.
248248
limit (Optional[int]):
@@ -1225,9 +1225,9 @@ def _filter_pb(field_or_unary) -> StructuredQuery.Filter:
12251225
"""Convert a specific protobuf filter to the generic filter type.
12261226
12271227
Args:
1228-
field_or_unary (Union[google.cloud.proto.firestore.v1.\
1229-
query.StructuredQuery.FieldFilter, google.cloud.proto.\
1230-
firestore.v1.query.StructuredQuery.FieldFilter]): A
1228+
field_or_unary (Union[google.cloud.firestore_v1.\
1229+
query.StructuredQuery.FieldFilter, google.cloud.\
1230+
firestore_v1.query.StructuredQuery.FieldFilter]): A
12311231
field or unary filter to convert to a generic filter.
12321232
12331233
Returns:
@@ -1272,7 +1272,7 @@ def _query_response_to_snapshot(
12721272
"""Parse a query response protobuf to a document snapshot.
12731273
12741274
Args:
1275-
response_pb (google.cloud.proto.firestore.v1.\
1275+
response_pb (google.cloud.firestore_v1.\
12761276
firestore.RunQueryResponse): A
12771277
collection (:class:`~google.cloud.firestore_v1.collection.CollectionReference`):
12781278
A reference to the collection that initiated the query.
@@ -1308,7 +1308,7 @@ def _collection_group_query_response_to_snapshot(
13081308
"""Parse a query response protobuf to a document snapshot.
13091309
13101310
Args:
1311-
response_pb (google.cloud.proto.firestore.v1.\
1311+
response_pb (google.cloud.firestore_v1.\
13121312
firestore.RunQueryResponse): A
13131313
collection (:class:`~google.cloud.firestore_v1.collection.CollectionReference`):
13141314
A reference to the collection that initiated the query.

google/cloud/firestore_v1/batch.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ def commit(
4949
system-specified value.
5050
5151
Returns:
52-
List[:class:`google.cloud.proto.firestore.v1.write.WriteResult`, ...]:
52+
List[:class:`google.cloud.firestore_v1.write.WriteResult`, ...]:
5353
The write results corresponding to the changes committed, returned
5454
in the same order as the changes were applied to this batch. A
5555
write result contains an ``update_time`` field.

google/cloud/firestore_v1/bulk_batch.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ def commit(
6161
system-specified value.
6262
6363
Returns:
64-
:class:`google.cloud.proto.firestore.v1.write.BatchWriteResponse`:
64+
:class:`google.cloud.firestore_v1.write.BatchWriteResponse`:
6565
Container holding the write results corresponding to the changes
6666
committed, returned in the same order as the changes were applied to
6767
this batch. An individual write result contains an ``update_time``

0 commit comments

Comments
 (0)