Updated readme to explicitly mention ListOptions pointer ownership (#553

)
linode · Jul 18, 2024 · 9a9c59a · 9a9c59a
1 parent c4e35af
commit 9a9c59a
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -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