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

Changed incorrect info in documentation regarding the return type of parse method. #5608

Merged
merged 2 commits into from
Oct 2, 2022

Conversation

zaid-ismail031
Copy link
Contributor

@zaid-ismail031 zaid-ismail031 commented Aug 25, 2022

Fixes #5602. I could not find any other similar errors (i.e. places where it says that the return type of a Request callback function must only be an iterable).

docs/topics/spiders.rst Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Aug 25, 2022

Codecov Report

Merging #5608 (3cf97e4) into master (3f060ae) will decrease coverage by 0.19%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #5608      +/-   ##
==========================================
- Coverage   88.85%   88.66%   -0.20%     
==========================================
  Files         162      162              
  Lines       10962    10962              
  Branches     1894     1894              
==========================================
- Hits         9740     9719      -21     
- Misses        942      963      +21     
  Partials      280      280              
Impacted Files Coverage Δ
scrapy/robotstxt.py 75.30% <0.00%> (-22.23%) ⬇️
scrapy/core/downloader/handlers/http11.py 93.13% <0.00%> (-0.99%) ⬇️

docs/topics/spiders.rst Outdated Show resolved Hide resolved
@elacuesta
Copy link
Member

elacuesta commented Aug 25, 2022

I think we have to explicitly mention None too, which is also a valid return value.

(Based on RFC 2119, since we're using the word "must" in this phrase)

Copy link
Contributor Author

@zaid-ismail031 zaid-ismail031 left a comment

Choose a reason for hiding this comment

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

@elacuesta Are you okay with the wording here?

@kmike
Copy link
Member

kmike commented Oct 2, 2022

Thanks @zaid-ismail031!

@kmike kmike merged commit 4f296b6 into scrapy:master Oct 2, 2022
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.

Clarify the return type of callbacks
5 participants