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.

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

Jump to bottom

Updated README to explicitly mention ListOptions pointer ownership #553

Merged
merged 1 commit into from
Jul 18, 2024
Merged

Updated README to explicitly mention ListOptions pointer ownership #553

merged 1 commit into from
Jul 18, 2024

Conversation

ezilber-akamai
Copy link
Contributor

📝 Description

Updated README to explicitly mention the following:

  • 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

@ezilber-akamai ezilber-akamai requested a review from a team as a code owner July 17, 2024 13:13
@ezilber-akamai ezilber-akamai requested review from lgarber-akamai and ykim-akamai and removed request for a team July 17, 2024 13:13
lgarber-akamai
lgarber-akamai approved these changes Jul 17, 2024
View reviewed changes
Copy link
Contributor

@lgarber-akamai lgarber-akamai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks perfect, great work!

ykim-akamai
ykim-akamai approved these changes Jul 18, 2024
View reviewed changes
Copy link
Contributor

@ykim-akamai ykim-akamai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ezilber-akamai ezilber-akamai merged commit 9a9c59a into linode:main Jul 18, 2024
4 checks passed
@ezilber-akamai ezilber-akamai deleted the TPT-2940-listoptions-docs branch July 18, 2024 19:22
@jriddle-linode jriddle-linode added the documentation for updates to the documentation in the changelog. label Jul 22, 2024
@shanduur shanduur mentioned this pull request Jul 31, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ykim-akamai ykim-akamai ykim-akamai approved these changes

@lgarber-akamai lgarber-akamai lgarber-akamai approved these changes

Assignees
No one assigned
Labels
documentation for updates to the documentation in the changelog.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ezilber-akamai @lgarber-akamai @ykim-akamai @jriddle-linode