Firestore: Insufficient documentation.

[Monabr]

trafficstars

Hi.

There is not enough documentation for Firestore. Even in KDoc there are almost no comments on functions explaining what each function or argument does, and what the function's result is.

Please cover all functionality with documentation.

[Reedyuk]

The general rule of thumb is to map it closely the Android sdk, you can see the google docs here:

https://firebase.google.com/docs/reference/kotlin/packages

Remember this library is just a wrapper of the current implementation, we are not re-inventing the wheel, just trying to unify things.

[Monabr]

@Reedyuk I understand that. But still some functions and parameters changed. If it is 1 to 1 implementation - comments could be just copied from the source. I believe a user of the library should be able to see the documentation directly on the the functionality and not spend additional time to search it separately.

[Reedyuk]

Happy for you to open a PR and we can review it.

[nbransby]

The current documentation was kindly contributed by @BasBuijsen here https://github.com/GitLiveApp/firebase-kotlin-sdk/pull/537

Definitely agree the relevant documentation should just be copied from the android documentation but as mentioned in the PR its a large piece of work that has yet to be contributed.