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

Establish a policy on the use of Sphinx directives for deprecations and version changes #3971

Closed
Gallaecio opened this issue Aug 21, 2019 · 0 comments · Fixed by #4310
Closed

Comments

@Gallaecio
Copy link
Member

Gallaecio commented Aug 21, 2019

I think we should make the following changes to make a better use of Sphinx’s deprecated, versionadded, and versionchanged directives:

  • Changes should include these tags when appropriate.
    We need to update the contribution documentation accordingly, and remember to enforce this during code reviews.
  • These tags should be removed in major version changes.
    Because of this, Scrapy 2.0 is probably the best time to implement this policy.
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.

1 participant