scrapinghub / scrapinghub/python-scrapinghub

Improve the documentation about the possible parameters of items.iter()

Open
#130 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I’m trying to understand the possible parameters of Job.items.iter() but it’s not that clear to me:

  • Why is count documented as a parameter on its own? (I assume the rest of the pagination parameters are assumed to be part of apiparameters)
  • What is requests_params for?
  • I see other parameters mentioned in the documentation that don’t seem part of the Items API, pagination or meta. For example, filter (in the 4th example of the Items documentation, with list instead of iter but I assume they accept the same arguments)

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 linked Job.items.iter() API documentation and the Items documentation examples. Compare how count, apiparameters, requests_params, and filter are described, then clarify which parameters are supported and how they relate to pagination and metadata. Done means the parameter documentation and examples consistently answer these questions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.