Skip to content

Commit

Permalink
Improve GoDoc for DBUpdates method
Browse files Browse the repository at this point in the history
  • Loading branch information
flimzy committed Dec 29, 2023
1 parent 6cd65a9 commit 92c90db
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion updates.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,11 @@ func (f *DBUpdates) Seq() string {
return f.curVal.(*driver.DBUpdate).Seq
}

// DBUpdates begins polling for database updates.
// DBUpdates begins polling for database updates. Canceling the context will
// close the iterator. The iterator will also close automatically if there are
// no more updates, when an error occurs, or when the [DBUpdates.Close] method
// is called. The [DBUpdates.Err] method should be consulted to determine if
// there was an error during iteration.
func (c *Client) DBUpdates(ctx context.Context, options ...Option) *DBUpdates {
updater, ok := c.driverClient.(driver.DBUpdater)
if !ok {
Expand Down

0 comments on commit 92c90db

Please sign in to comment.