Skip to content

Commit

Permalink
docs: add docstring to docref watch (#3620)
Browse files Browse the repository at this point in the history
#2601

Upon inspection, it seems we added a disclaimer to one of the two watch docstrs.
  • Loading branch information
crwilcox committed Jan 29, 2021
1 parent b8ada6f commit 3979aee
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion firestore/docref.go
Expand Up @@ -795,7 +795,8 @@ type DocumentSnapshotIterator struct {
// the current state of the document. If the document has been deleted, Next
// returns a DocumentSnapshot whose Exists method returns false.
//
// Next never returns iterator.Done unless it is called after Stop.
// Next is not expected to return iterator.Done unless it is called after Stop.
// Rarely, networking issues may also cause iterator.Done to be returned.
func (it *DocumentSnapshotIterator) Next() (*DocumentSnapshot, error) {
btree, _, readTime, err := it.ws.nextSnapshot()
if err != nil {
Expand Down

0 comments on commit 3979aee

Please sign in to comment.