encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-08-08 14:24:48 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add note on use of deprecated

Browse Source
This commit is contained in:
Carlton Gibson 2015-09-15 11:13:56 +02:00
parent 8ac78daf18
commit 968832043a
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/topics/release-notes.md
View File

@ -24,6 +24,12 @@ The timeline for deprecation of a feature present in version 1.0 would work as f
* Version 1.3 would remove the deprecated bits of API entirely.
Deprecations are marked using `rest_framework.compat.deprecated`, which accepts a version tuple for the version when code is first deprecated and message to pass to the `warnings` module:
from rest_framework.compat import deprecated
...
deprecated((3,1,0), "Using X for Y is deprecated. Prefer Z")
Note that in line with Django's policy, any parts of the framework not mentioned in the documentation should generally be considered private API, and may be subject to change.
## Upgrading