This repository was archived by the owner on Aug 30, 2026. It is now read-only.
Repository navigation
This repository was archived by the owner on Aug 30, 2026. It is now read-only.
Firestore API docs do not reflect the released distributions #13
Description
API docs for Cloud Firestore seem to be auto-generated from the master branch: https://googleapis.github.io/google-cloud-python/latest/firestore/collection.html#google.cloud.firestore_v1beta1.collection.CollectionReference
This contains several APIs that are not yet available in any of the released distributions (e.g. stream(), list_documents()). This often sends developers down the wrong path, that results in Python attribute errors.
Reacted by Sam Zeitlin and jubeater
Activity
tseaver commentedon Mar 19, 2019
@hiranya911 We don't have a way to version our API-specific docs, so we cannot really address this issue at this time. We are at work on getting a new release out, which will mitigate the issue a bit (but it will continue to recur).
hiranya911 commentedon Mar 19, 2019
Can you generate docs from the latest tag instead of the master branch?
tseaver commentedon Mar 20, 2019
@hiranya911
I'm afraid not. The docs are currently generated for the repository as a whole, rather than for individual client libraries. We have plans to split the repository up, and therefore the docs generation: at that point, we will be able to have a meaningful
stablevs.latestbuild of the docs.szeitlin commentedon Jun 19, 2019
How's it going with this effort? I'm also finding errors in the docs.
tseaver commentedon Jun 19, 2019
@szeitlin Splitting the repository is prioritized for Q3, which should allow us to build versioned docs for each API.
max-sixty commentedon Sep 16, 2019
FYI here the docs are behind rather than ahead—first run I have on firestore using the example from the Readme:
DeprecationWarning: 'Collection.get' is deprecated: please use 'Collection.stream' instead.tseaver commentedon Sep 16, 2019
@max-sixty Thanks for the report: that sample needs updating.
BenWhitehead commentedon Feb 14, 2020
With the new docs site https://googleapis.dev/python/firestore/latest/collection.html , the docs are versioned along with the release of google-firestore and can be switched between with the drop down in the lower-right corner.