Skip to content

Commit e02adb8

Browse files
authored
Merge pull request #128 from scrapinghub/extend-docs-for-cancelling-jobs
Extend docs for new cancelation feature
2 parents 7bc63e3 + 51e2d2a commit e02adb8

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/client/overview.rst

+13
Original file line numberDiff line numberDiff line change
@@ -322,6 +322,19 @@ Modifying tags is available at :class:`~scrapinghub.client.spiders.Spider`
322322
level and :class:`~scrapinghub.client.jobs.Job` level.
323323

324324

325+
Canceling jobs
326+
^^^^^^^^^^^^^^
327+
328+
To cancel a few jobs by keys at once::
329+
330+
>>> spider.jobs.cancel(['123/1/2', '123/1/3'])
331+
332+
All jobs should belong to the same project.
333+
334+
Note that there's a limit on amount of job keys you can cancel with a single call,
335+
please contact support if the amount is more than 1k.
336+
337+
325338
.. _job:
326339

327340

0 commit comments

Comments
 (0)