Skip to content

Updated README to explicitly mention ListOptions pointer ownership #553

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.

Sign up for GitHub

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

Merged
ezilber-akamai merged 1 commit into from
Jul 18, 2024
Merged

Updated README to explicitly mention ListOptions pointer ownership #553

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,11 @@ values are set in the supplied ListOptions.
// opts.Results == 218
```

> **_NOTES:_**
> - The ListOptions will be mutated by list endpoint functions.
> - Instances of ListOptions should NOT be shared across multiple list endpoint functions.
> - The resulting number of results and pages can be accessed through the user-supplied ListOptions instance.

#### Filtering

```go
Expand Down