scrapinghub / scrapinghub/python-scrapinghub
Incorrect information for Samples in Job documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 205
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
At this link - https://python-scrapinghub.readthedocs.io/en/latest/client/overview.html#job-data-1, the description for samples refer to the job stats which is confusing and seems incorrect.
I think it should be runtime samples that the job uploaded;
Please correct me if I have misinterpreted this.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked client overview documentation and locate the Job Data section describing samples. Compare that description with the surrounding job fields and update the wording so it accurately explains what samples contains. Rebuild or preview the documentation and confirm the rendered description no longer refers confusingly to job stats.
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
- Clearly specified
- Newbie friendliness
- 72/100