Determine this is the right repository
Summary of the feature request
google/cloud/firestore_v1/client.py::recursive_delete() return value is not documented.
Anyone using the recursive_delete() function will get a number and not understand the meaning of it without digging in the implementation which actually calls another function called _recursive_delete().
Desired code experience
file: client.py
def recursive_delete(
self,
reference: Union[CollectionReference, DocumentReference],
*,
bulk_writer: Optional["BulkWriter"] = None,
chunk_size: int = 5000,
) -> int:
"""Deletes documents and their subcollections, regardless of collection
name.
Passing a CollectionReference leads to each document in the collection
getting deleted, as well as all of their descendents.
Passing a DocumentReference deletes that one document and all of its
descendents.
Args:
reference (Union[
:class:`@google.cloud.firestore_v1.collection.CollectionReference`,
:class:`@google.cloud.firestore_v1.document.DocumentReference`,
])
The reference to be deleted.
bulk_writer (Optional[:class:`@google.cloud.firestore_v1.bulk_writer.BulkWriter`])
The BulkWriter used to delete all matching documents. Supply this
if you want to override the default throttling behavior.
Returns:
int: The number of documents deleted.
"""
Expected results
recursive_delete() should specify what is the returned int value
API client name and version
No response
Use case
Anyone using the recursive_delete() function that desires to make use of the return value.
Additional context
No response
Determine this is the right repository
Summary of the feature request
google/cloud/firestore_v1/client.py::recursive_delete() return value is not documented.
Anyone using the recursive_delete() function will get a number and not understand the meaning of it without digging in the implementation which actually calls another function called _recursive_delete().
Desired code experience
file: client.py
Expected results
recursive_delete() should specify what is the returned int value
API client name and version
No response
Use case
Anyone using the recursive_delete() function that desires to make use of the return value.
Additional context
No response