Skip to content

Iterator note #159

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.

Sign up for GitHub

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 3 commits into from
May 5, 2022
Merged

Iterator note #159

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1e71ed2
add limit note
May 5, 2022
bc5d8fe
rephrase
May 5, 2022
fa172f0
add internal link for enums
May 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/source/Getting-Started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,12 @@ For paginated endpoints call :code:`list_*` and use the provided iterator:
trades.append(t)
print(trades)

For endpoints that have a set of parameters you can use the provided enums:
.. note::
The number of network requests made by the iterator depends on the value of the parameter :code:`limit`.
:code:`limit` specifies how many results should be returned per network request.
You can see each network request by passing :code:`verbose = True` to the client.

For endpoints that have a set of parameters you can use the provided :doc:`enums </Enums>`.

.. code-block:: python

Expand Down