Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve method comments #56

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions querybuilder.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@ func (q *QueryBuilder) ExecuteWithContext(ctx context.Context) ([]byte, int64, e

// ExecuteTo runs the PostgREST query, encoding the result to the supplied
// interface. Note that the argument for the to parameter should always be a
// reference to a slice.
// reference to a slice unless the filter method Single is specified.
func (q *QueryBuilder) ExecuteTo(to interface{}) (int64, error) {
return executeTo(context.Background(), q.client, q.method, q.body, to, []string{q.tableName}, q.headers, q.params)
}

// ExecuteToWithContext runs the PostgREST query with the given context,
// encoding the result to the supplied interface. Note that the argument for
// the to parameter should always be a reference to a slice.
// the to parameter should always be a reference to a slice unless the filter method Single is specified.
func (q *QueryBuilder) ExecuteToWithContext(ctx context.Context, to interface{}) (int64, error) {
return executeTo(ctx, q.client, q.method, q.body, to, []string{q.tableName}, q.headers, q.params)
}
Expand Down