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

versionadded inside a warning in CrawlSpider docs #5180

Closed
wRAR opened this issue Jun 15, 2021 · 1 comment · Fixed by #5194
Closed

versionadded inside a warning in CrawlSpider docs #5180

wRAR opened this issue Jun 15, 2021 · 1 comment · Fixed by #5194

Comments

@wRAR
Copy link
Member

wRAR commented Jun 15, 2021

https://docs.scrapy.org/en/latest/topics/spiders.html#crawlspider has a warning block that includes the "New in version" line.

Both indenting the warning block (not sure what's the best practice for the indentation here; also, XMLFeedSpider below has the same block which should have the same indentation I think) and moving versionadded before it (I think I don't like it) will work but I don't know which is the correct way to position these blocks.

@rudanov
Copy link

rudanov commented Jun 15, 2021

Hey! I am new here and I would like to take care of this issue.
I think the most correct way to do "New in version" block is how it's done here: https://docs.scrapy.org/en/latest/topics/request-response.html#scrapy.http.Response

A block in the beginning of the class description and additional block in the description of the attribute.
I also suggest changing marking of the attributes in CrawlingRules similar to Response docs:
link_extractor => .. attribute:: Rule.link_extractor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants