Skip to content

docs: use as_list=False or all=True in Getting started #1884

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

Merged
merged 1 commit into from
May 29, 2022

Conversation

JohnVillalovos
Copy link
Member

In the "Getting started with the API" section of the documentation,
use either as_list=False or all=True in the example usages of the
list() method.

Also add a warning about the fact that list() by default does not
return all items.

@JohnVillalovos JohnVillalovos force-pushed the jlvillal/list_docs branch 2 times, most recently from 42f43b8 to 094f434 Compare February 6, 2022 18:54
@JohnVillalovos JohnVillalovos marked this pull request as draft February 12, 2022 16:54
In the "Getting started with the API" section of the documentation,
use either `as_list=False` or `all=True` in the example usages of the
`list()` method.

Also add a warning about the fact that `list()` by default does not
return all items.
@JohnVillalovos JohnVillalovos marked this pull request as ready for review May 29, 2022 16:52
@JohnVillalovos
Copy link
Member Author

@nejch Since you approved this I rebased it and also removed the "Draft" status.

@nejch nejch merged commit 5ae18d0 into main May 29, 2022
@nejch nejch deleted the jlvillal/list_docs branch May 29, 2022 17:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants