Skip to content

Commit b95d703

Browse files
committed
Update docs referebcesto docs.zyte.com.
1 parent 4132ced commit b95d703

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

CHANGES.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Changes
55
------------------
66

77
* Improved how the :ref:`default retry policy <default-retry-policy>` handles
8-
:ref:`temporary download errors <zyte-api-temporary-download-errors>`.
8+
:ref:`temporary download errors <zapi-temporary-download-errors>`.
99
Before, 3 HTTP 429 responses followed by a single HTTP 520 response would
1010
have prevented a retry. Now, unrelated responses and errors do not count
1111
towards the HTTP 520 retry limit.

docs/use/api.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -134,40 +134,40 @@ The number of concurrent connections if enforced across all method calls,
134134
including different sessions of the same client.
135135

136136
For guidelines on how to choose the optimal value for you, and other
137-
optimization tips, see :ref:`zyte-api-optimize`.
137+
optimization tips, see :ref:`zapi-optimize`.
138138

139139

140140
Errors and retries
141141
==================
142142

143143
Methods of :class:`ZyteAPI` and :class:`AsyncZyteAPI` automatically handle
144-
retries for :ref:`rate-limiting <zyte-api-rate-limit>` and :ref:`unsuccessful
145-
<zyte-api-unsuccessful-responses>` responses, as well as network errors.
144+
retries for :ref:`rate-limiting <zapi-rate-limit>` and :ref:`unsuccessful
145+
<zapi-unsuccessful-responses>` responses, as well as network errors.
146146

147147
.. _retry-policy:
148148
.. _default-retry-policy:
149149

150150
The default retry policy, :data:`~zyte_api.zyte_api_retrying`, does the
151151
following:
152152

153-
- Retries :ref:`rate-limiting responses <zyte-api-rate-limit>` forever.
153+
- Retries :ref:`rate-limiting responses <zapi-rate-limit>` forever.
154154

155155
- Retries :ref:`temporary download errors
156-
<zyte-api-temporary-download-errors>` up to 3 times.
156+
<zapi-temporary-download-errors>` up to 3 times.
157157

158158
- Retries network errors until they have happened for 15 minutes straight.
159159

160160
All retries are done with an exponential backoff algorithm.
161161

162162
.. _aggressive-retry-policy:
163163

164-
If some :ref:`unsuccessful responses <zyte-api-unsuccessful-responses>` exceed
164+
If some :ref:`unsuccessful responses <zapi-unsuccessful-responses>` exceed
165165
maximum retries with the default retry policy, try using
166166
:data:`~zyte_api.aggressive_retrying` instead, which modifies the default retry
167167
policy as follows:
168168

169169
- Temporary download error are retried 7 times. :ref:`Permanent download
170-
errors <zyte-api-permanent-download-errors>` also count towards this retry
170+
errors <zapi-permanent-download-errors>` also count towards this retry
171171
limit.
172172

173173
- Retries permanent download errors up to 3 times.

docs/use/cli.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The input file can be either of the following:
3333
:http:`request:browserHtml` set to ``True``.
3434

3535
- A `JSON Lines <https://jsonlines.org/>`_ file with a object of :ref:`Zyte
36-
API request parameters <zyte-api-reference>` per line. For example:
36+
API request parameters <zapi-reference>` per line. For example:
3737

3838
.. code-block:: json
3939
@@ -84,19 +84,19 @@ order and hence distribute the load somewhat evenly:
8484
zyte-api urls.txt --shuffle …
8585
8686
For guidelines on how to choose the optimal ``--n-conn`` value for you, and
87-
other optimization tips, see :ref:`zyte-api-optimize`.
87+
other optimization tips, see :ref:`zapi-optimize`.
8888

8989

9090
Errors and retries
9191
==================
9292

9393
``zyte-api`` automatically handles retries for :ref:`rate-limiting
94-
<zyte-api-rate-limit>` and :ref:`unsuccessful
95-
<zyte-api-unsuccessful-responses>` responses, as well as network errors,
94+
<zapi-rate-limit>` and :ref:`unsuccessful
95+
<zapi-unsuccessful-responses>` responses, as well as network errors,
9696
following the :ref:`default retry policy <default-retry-policy>`.
9797

9898
Use ``--dont-retry-errors`` to disable the retrying of error responses, and
99-
retrying only :ref:`rate-limiting responses <zyte-api-rate-limit>`:
99+
retrying only :ref:`rate-limiting responses <zapi-rate-limit>`:
100100

101101
.. code-block:: shell
102102

zyte_api/_errors.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010

1111
class RequestError(ClientResponseError):
1212
"""Exception raised upon receiving a :ref:`rate-limiting
13-
<zyte-api-rate-limit>` or :ref:`unsuccessful
14-
<zyte-api-unsuccessful-responses>` response from Zyte API."""
13+
<zapi-rate-limit>` or :ref:`unsuccessful
14+
<zapi-unsuccessful-responses>` response from Zyte API."""
1515

1616
def __init__(self, *args, **kwargs):
1717
#: Query sent to Zyte API.

zyte_api/_retry.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ class RetryFactory:
137137
the corresponding :class:`tenacity.AsyncRetrying` object.
138138
139139
For example, to double the number of attempts for :ref:`temporary
140-
download errors <zyte-api-temporary-download-errors>` and the time network
140+
download errors <zapi-temporary-download-errors>` and the time network
141141
errors are retried:
142142
143143
.. code-block:: python

0 commit comments

Comments
 (0)