Opened 11 years ago
Closed 11 years ago
#21024 closed Cleanup/optimization (fixed)
In the contributing guide document how to deprecate a feature
Reported by: | Tim Graham | Owned by: | nobody |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Accepted | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description (last modified by )
Somewhere in internals/contributing
we document guidelines for deprecating a feature. I couldn't find anything on this after a quick search.
This includes how to silence deprecation warnings:
When a feature is deprecated, it raises a PendingDeprecationWarning
, either at import time or at run time. After the following release it raises DeprecationWarning
. Assuming we have a good test coverage, these warnings will be shown by the test suite, with -Wall
for PendingDeprecationWarning
, or by default for DeprecationWarning
. This is annoying. The output of the test suite should remain clean.
Aymeric's full post including how to silence warnings:
https://groups.google.com/forum/#!topic/django-developers/nXlNqpy6sC8
Attachments (1)
Change History (8)
comment:1 by , 11 years ago
Description: | modified (diff) |
---|
comment:2 by , 11 years ago
Worth mentioning that we should make sure to take care when silencing deprecation warnings - eating our own dogfood must be the first step to removing the warnings.
comment:3 by , 11 years ago
I think I may have found the location in the docs to be in the Minor Releases section of the Release Process page.
comment:4 by , 11 years ago
Has patch: | set |
---|
by , 11 years ago
Attachment: | 21024.diff added |
---|
comment:5 by , 11 years ago
"The first step is to remove any use of the deprecated behavior by Django itself"
What's about cases when some code doesn't used by Django itself?
comment:6 by , 11 years ago
I'm not sure how common that would be. I guess I would handle that on a case by case basis.
comment:7 by , 11 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
#21025 was a duplicate.