Doc Comments

[jokil123]

Most of the libraries functions are not annotated using doc comments. It would be really helpful for development in many cases. I have started to annotate some, but its somewhat difficult because of my lacking experience with the library.

[jokil123]

I have opened a pull request: #57 (new one #72)

[abdolence]

Hey, thanks for helping out with the documentations, it is always appreciated.

I'm doing my best to documenting the most important things in README here and examples for now (maybe I'll expand it to a book later).
However there are always room for new docs including doc annotations.

Please let me know in the PR or in the comment If you see some function that caused some struggling for you - it is actually great to have additional eyes to have a look at this, if we have some confusing name or places to document it (or even rename it) where possible.

Saying that please avoid documenting internal APIs (including the 'Classic API'), since it probably will be changed (or even hidden to users) with in next releases. The current idea is to rely in the apps on the Fluent API and models that it uses and hide complexity.

[jokil123]

I have only been using the fluent api, so I had no intention to document the classic api

[thurn]

One thing I'm bit confused about @abdolence is whether you are supposed to have a single global FirestoreDb instance in your program or create a different one for each request, it would be good to have some 'expected use' documentation.

[abdolence]

@thurn a good point.

Hope this answers your question:
https://github.com/abdolence/firestore-rs#firestore-database-client-instance-lifecycle
Let me know if I can describe it more.