Skip to content

Commit

Permalink
Document new option ignore_incomplete_reads.
Browse files Browse the repository at this point in the history
  • Loading branch information
wfrisch committed Feb 14, 2024
1 parent 0ea72dc commit 593f052
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ The format mostly follows [Keep a Changelog](http://keepachangelog.com/en/1.0.0/
### Added

- New `enabled` option for all jobs. Set to false to disable a job without needing to remove it or comment it out (Requested in #625 by snowman, contributed in #785 by jamstah)
- New option `ignore_incomplete_reads (PR#787, by wfrisch)

### Changed

Expand Down
6 changes: 6 additions & 0 deletions docs/source/advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,12 @@ or ignore all HTTP errors if you like:
url: https://example.com/
ignore_http_error_codes: 4xx, 5xx
You can also ignore incomplete reads:

.. code-block:: yaml
url: "https://example.com/"
ignore_incomplete_reads: true
Overriding the content encoding
-------------------------------
Expand Down
1 change: 1 addition & 0 deletions docs/source/jobs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Job-specific optional keys:
- ``ignore_http_error_codes``: List of HTTP errors to ignore (see :ref:`advanced_topics`)
- ``ignore_timeout_errors``: Do not report errors when the timeout is hit
- ``ignore_too_many_redirects``: Ignore redirect loops (see :ref:`advanced_topics`)
- ``ignore_incomplete_reads``: Ignore incomplete HTTP responses (see :ref:`advanced_topics`)

(Note: ``url`` implies ``kind: url``)

Expand Down

0 comments on commit 593f052

Please sign in to comment.