Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docstrings to spider classes 2 #393

Merged
merged 19 commits into from
Jun 25, 2020
Merged

Add docstrings to spider classes 2 #393

merged 19 commits into from
Jun 25, 2020

Conversation

aguilerapy
Copy link
Contributor

@aguilerapy aguilerapy requested a review from romifz May 29, 2020 18:43
@jpmckinney
Copy link
Member

@yolile @romifz Can this be reviewed this week?

Copy link
Contributor

@romifz romifz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Andrés, I proposed some changes to the docstrings, can you please review them and check that they are correct?

kingfisher_scrapy/spiders/afghanistan_records.py Outdated Show resolved Hide resolved
https://ocds.ageops.net/
Spider arguments
sample
Download only 1 release.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Download only 1 release.
Downloads the first release returned by the release endpoint of the API

https://datosabiertos.vialidad.gob.ar/ui/index.html#!/datos_abiertos
Spider arguments
sample
Download one set of releases.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Download one set of releases.
Ignored, data is downloaded from a single JSON file

kingfisher_scrapy/spiders/canada_buyandsell.py Outdated Show resolved Hide resolved
kingfisher_scrapy/spiders/canada_montreal.py Outdated Show resolved Hide resolved
"""
Spider arguments
sample
Download only one set of records.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Download only one set of records.
Downloads the first page of records for each available endpoint (budgets, tenders)

http://opencontracting.date.gov.md/downloads
Spider arguments
sample
Download only data released on 2017.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Download only data released on 2017.
Downloads a single JSON file containing data for 2017

https://api.publiccontractsscotland.gov.uk/v1
Spider arguments
sample
Download only 21 releases.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Download only 21 releases.
Downloads packages for releases dated one year ago, for each notice type available

"""
Spider arguments
sample
Download only 100 release packages.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Download only 100 release packages.
Downloads the first page of release packages returned by the main endpoint

"""
Spider arguments
sample
Download only 1 release package.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Download only 1 release package.
Downloads the first release package returned by the main endpoint

aguilerapy and others added 5 commits June 23, 2020 18:02
@aguilerapy aguilerapy requested a review from romifz June 24, 2020 15:27
@yolile yolile merged commit 1b4f2b1 into master Jun 25, 2020
@yolile yolile deleted the 347-add_docstrings_2 branch June 25, 2020 16:57
@aguilerapy aguilerapy mentioned this pull request Jun 26, 2020
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants