scrapinghub / scrapinghub/python-scrapinghub

Jobs.iter_last start and start_after parameters undocumented

Open
#136 1 comment 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

If I look at the jobs.iter documentation I would assume that start is an integer count of recent jobs to skip, but I get this error

Invalid "start" value: Key '0' is not a spider key, must have 2 part(-s)

which makes it seem like it might be expecting a job id here minus the project part?

I can't find the code for start_after/startafter anywhere. It could be either a number of jobs to skip or a timestamp. If it's a timetamp I'm not sure if "after" means "after in sort order" or "after chronologically (job time > start 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

Start with the jobs.iter documentation and trace the client entry points for the start, start_after, and startafter parameters. Reproduce the reported error and verify each parameter's accepted value and ordering semantics against the API behavior. Done means the documentation clearly defines the parameters and includes an accurate usage example.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.