Skip to content
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

Update api.py with docstring for paginate #18

Merged
merged 2 commits into from
May 20, 2023

Commits on May 17, 2023

  1. Update api.py

    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
            """
    zlatko-minev authored May 17, 2023
    Configuration menu
    Copy the full SHA
    fe38080 View commit details
    Browse the repository at this point in the history

Commits on May 20, 2023

  1. Update pyalex/api.py

    J535D165 authored May 20, 2023
    Configuration menu
    Copy the full SHA
    6ced10d View commit details
    Browse the repository at this point in the history