scrapinghub / scrapinghub/python-scrapinghub

Documentation conflicts regarding jobs.iter limits

Open
#135 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
205
Forks
62
PR merge metrics
No merged PRs in 30d

Description

In the documentation for jobs.iter it says

retrieve all jobs for a spider
.>>> spider.jobs.iter()

however if there's an implicit limit of 1000 results then this will not return all jobs for a spider, only if there are equal to or fewer than 1000 jobs for the spider. I don't believe there's a method in the API to get all jobs for a spider at this time.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the documentation entry for jobs.iter and verify the stated behavior against its implicit 1000-result limit. Update the wording so it does not claim to retrieve all jobs when the limit applies, and clarify whether the API provides a way to retrieve more results.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.