From 1e71ed2ef09df4a9f65bdfc98808daa50c84f9cb Mon Sep 17 00:00:00 2001 From: Darcy Linde <{47221647+Darcy-Linde@users.noreply.github.com}> Date: Thu, 5 May 2022 14:58:58 -0400 Subject: [PATCH 1/3] add limit note --- docs/source/Getting-Started.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/source/Getting-Started.rst b/docs/source/Getting-Started.rst index 549f2d50..5f1a57ae 100644 --- a/docs/source/Getting-Started.rst +++ b/docs/source/Getting-Started.rst @@ -40,6 +40,11 @@ For paginated endpoints call :code:`list_*` and use the provided iterator: trades.append(t) print(trades) +.. note:: + The number of network requests made by the iterator depends on the value given for the query 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 enums: .. code-block:: python From bc5d8fe17eb9e3de2de417be8dc55e87653741d0 Mon Sep 17 00:00:00 2001 From: Darcy Linde <{47221647+Darcy-Linde@users.noreply.github.com}> Date: Thu, 5 May 2022 15:03:27 -0400 Subject: [PATCH 2/3] rephrase --- docs/source/Getting-Started.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/Getting-Started.rst b/docs/source/Getting-Started.rst index 5f1a57ae..0304154c 100644 --- a/docs/source/Getting-Started.rst +++ b/docs/source/Getting-Started.rst @@ -41,7 +41,7 @@ For paginated endpoints call :code:`list_*` and use the provided iterator: print(trades) .. note:: - The number of network requests made by the iterator depends on the value given for the query parameter :code:`limit`. + 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. From fa172f022f47137325a82a97cf84d844c2c30024 Mon Sep 17 00:00:00 2001 From: Darcy Linde <{47221647+Darcy-Linde@users.noreply.github.com}> Date: Thu, 5 May 2022 15:16:33 -0400 Subject: [PATCH 3/3] add internal link for enums --- docs/source/Getting-Started.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/Getting-Started.rst b/docs/source/Getting-Started.rst index 0304154c..1bd896da 100644 --- a/docs/source/Getting-Started.rst +++ b/docs/source/Getting-Started.rst @@ -45,7 +45,7 @@ For paginated endpoints call :code:`list_*` and use the provided iterator: :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 enums: +For endpoints that have a set of parameters you can use the provided :doc:`enums `. .. code-block:: python