search

firebase / geofire-java

GeoFire for Java - Realtime location queries with Firebase
MIT License
670 stars 271 forks source link

Add documentation to the testing module. #128

Closed vanniktech closed 6 years ago

vanniktech commented 6 years ago

Took me a bit longer since I've gotten sick along the way but happy to finally pick this up again.

I've started adding documentation to most of the public methods. Please let me know when you want to rephrase certain things or something in the documentation is either incorrect or unclear.

I've also added constructors to GeoFireTestingRule & TestCallback to control some of the constants that were hardcoded.

I think the only thing left after this is whether we want to rename some of the methods? I'd prefer setLocation vs setLoc. Same for removing. Otherwise I think this is pretty good for a first version.

Part of #101

vanniktech commented 6 years ago

I'm getting some weird error when building locally. I addressed the requests and this should be looking good now.

samtstern commented 6 years ago

@vanniktech LGTM