Skip to content

BulkWriter type doesn't appear in Firestore module #769

@telpirion

Description

@telpirion

The official client library reference doesn't include documentation of the BulkWriter type. It only includes a reference to the BaseClient.bulk_writer() factory method.
https://cloud.google.com/python/docs/reference/firestore/latest/google.cloud.firestore_v1.base_client.BaseClient#google_cloud_firestore_v1_base_client_BaseClient_bulk_writer

This effectively obscures the BulkWriter from customers, as they can't find it in the reference docs and it isn't used in any samples. It looks like a reference to BulkWriter needs to be added here:
https://github.com/googleapis/python-firestore/blob/main/google/cloud/firestore_v1/__init__.py

Metadata

Metadata

Assignees

Labels

api: firestoreIssues related to the googleapis/python-firestore API.priority: p3Desirable enhancement or fix. May not be included in next release.type: docsImprovement to the documentation for an API.

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions