docs: use as_list=False or all=True in Getting started#1884
Merged
Conversation
JohnVillalovos
force-pushed
the
jlvillal/list_docs
branch
2 times, most recently
from
42f43b8 to
094f434
Compare
nejch
reviewed
Feb 6, 2022
nejch
approved these changes
May 29, 2022
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
force-pushed
the
jlvillal/list_docs
branch
from
094f434 to
de8c6e8
Compare
Member
Author
|
@nejch Since you approved this I rebased it and also removed the "Draft" status. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In the "Getting started with the API" section of the documentation,
use either
as_list=Falseorall=Truein the example usages of thelist()method.Also add a warning about the fact that
list()by default does notreturn all items.