Document paging parameter in get_data() and improve corresponding examples #44
Conversation
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
…e get_data() docstring
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
@ldegio was alerted by a user who was tripped up by the fact that our
get_data_advanced.pyexample was only returning the top 10 entities. Theget_data_simple.pytalks about this in reference to thepagingparameter, but it's confusing that the "advanced" example leaves this out, and is further compounded by the fact thatget_data()was lacking any documentation of this parameter.This PR adds the docstring in
get_data(), moves the use ofpagingfrom the simple example to the advanced one, and uses non-default values forpagingto better illustrate its use.I've cleaned up some other typos while I'm in there.
cc: @ndrwdn @ldegio