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

Document the Scrapy component API #5110

Open
Gallaecio opened this issue Apr 21, 2021 · 2 comments · May be fixed by #5439
Open

Document the Scrapy component API #5110

Gallaecio opened this issue Apr 21, 2021 · 2 comments · May be fixed by #5439

Comments

@Gallaecio
Copy link
Member

Gallaecio commented Apr 21, 2021

There are certain classes in Scrapy that may optionally define the from_crawler and from_settings class methods.

At the moment, we document this fact in every single one of them. We repeat ourselves a lot. But we also often fail to cover how to properly subclass a class that defines one of these methods.

I think we need to extend the documentation with a section or a page about this type of classes, and have all such classes reference this central documentation instead of providing their own documentation about this aspect of such classes.

@OrestisKan
Copy link

Hi, @Gallaecio seems like this issue is still relevant, right? If so I would like to work on it.

@Gallaecio
Copy link
Member Author

Thanks!

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

Successfully merging a pull request may close this issue.

2 participants