Update api.py with docstring for paginate #18
Merged
Conversation
This file contains 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
Added docstring to paginate to explain what n_max is and the function does.
"""Used for paging results of large responses using cursor paging.
OpenAlex offers two methods for paging: basic paging and cursor paging.
Both methods are supported by PyAlex, although cursor paging seems to be
easier to implement and less error-prone.
Args:
per_page (_type_, optional): Entries per page to return. Defaults to None.
cursor (str, optional): _description_. Defaults to "*".
n_max (int, optional): Number of max results (not pages) to return.
Defaults to 10000.
Returns:
CursorPaginator: Itterator
"""
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.
Added docstring to paginate to explain what n_max is and the function does.