Python-Firestore API Documentation

[martindufort]

Hi,

We are currently integrating Cloud Firestore (using the Python client) into one of our project.

However we have some difficulties grasping all the capabilities because it seems the API documentation here is incomplete.

I have to resort to browsing the GitHub source code to grasp which methods are available to perform a specific behavior.

Example: In the API Documentation there is no reference to class DocumentSnapshot I could find.

Some of the questions, I was asking myself:
How do I get a DocumentReference from a DocumentSnapshot instance ?

I had to browse the class DocumentSnapshot source code and find that the property reference was available for that.

Let me know if I'm not looking at the proper location.
Thanks for your support.

[martindufort]

Is the public documentation web page now reflecting all classes ?

[HemangChothani]

Yes, i think only DocumentSnapshot class was missing.

[tseaver]

Nope. Please see 9fdad0c (part of PR #279) for other cases where the "async split" left classes undocumented.

[martindufort]

I'm looking here https://googleapis.dev/python/firestore/latest/document.html and I don't see DocumentSnaphot documentation.

[HemangChothani]

@martindufort DocumentSnaphot is added in #263 PR, waiting for merge.

[HemangChothani]

@tseaver I was not aware about exposing the documentation of async classes.

[martindufort]

@martindufort DocumentSnaphot is added in #263 PR, waiting for merge.

Any timeline in closing this PR ?

[1337SEnergy]

there seems to be many more issues with the documentation, for example the documentation for DocumentChange says there are document, target_ids and removed_target_ids fields, however from my inspection there are document, old_index, new_index and type fields instead...

as mentioned by @martindufort, I have to rely on code inspection to fully grasp how this library actually works, as the documentation is of very little help and in a lot of cases seems outdated