Skip to content

Updated README to explicitly mention ListOptions pointer ownership#553

Merged
ezilber-akamai merged 1 commit intolinode:mainfrom
ezilber-akamai:TPT-2940-listoptions-docs
Jul 18, 2024
Merged

Updated README to explicitly mention ListOptions pointer ownership#553
ezilber-akamai merged 1 commit intolinode:mainfrom
ezilber-akamai:TPT-2940-listoptions-docs

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
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!

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
@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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation for updates to the documentation in the changelog.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants