mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-11-22 17:47:04 +03:00
Release notes
This commit is contained in:
parent
0c65e028b6
commit
874d2be83c
BIN
docs/img/labels-and-milestones.png
Normal file
BIN
docs/img/labels-and-milestones.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 82 KiB |
|
@ -95,17 +95,53 @@ Here's an example of using the new decorators. Firstly we have a detail-type rou
|
|||
serializer = self.get_pagination_serializer(page)
|
||||
return Response(serializer.data)
|
||||
|
||||
For more details, see the [viewsets](../api-guide/viewsets.md) documentation.
|
||||
For more details, see the [viewsets documentation](../api-guide/viewsets.md).
|
||||
|
||||
## Other features
|
||||
|
||||
## Deprecations
|
||||
There are also a number of other features and bugfixes as [listed in the release notes][2-4-release-notes]. In particular these include:
|
||||
|
||||
[Customizable view name and description functions][view-name-and-description-settings] for use with the browsable API, by using the `VIEW_NAME_FUNCTION` and `VIEW_DESCRIPTION_FUNCTION` settings.
|
||||
|
||||
Smarter [client IP identification for throttling][client-ip-identification], with the addition of the `NUM_PROXIES` setting.
|
||||
|
||||
## Deprecations
|
||||
|
||||
All API changes in 2.3 that previously raised `PendingDeprecationWarning` will now raise a `DeprecationWarning`, which is loud by default.
|
||||
|
||||
All API changes in 2.3 that previously raised `DeprecationWarning` have now been removed entirely.
|
||||
|
||||
Furter details on these deprecations is available in the [2.3 announcement][2-3-announcement].
|
||||
|
||||
## Labels and milestones
|
||||
|
||||
TODO
|
||||
Although not strictly part of the 2.4 release it's also worth noting here that we've been working hard towards improving our triage process.
|
||||
|
||||
* `allow_none` for char fields
|
||||
* `trailing_slash = True` --> `[^/]`, `trailing_slash = False` --> `[^/.]`, becomes simply `[^/]` and `lookup_value_regex` is added.
|
||||
The [labels that we use in GitHub][github-labels] have been cleaned up, and all existing tickets triaged. Any given ticket should have one and only one label, indicating its current state.
|
||||
|
||||
[lts-releases]: https://docs.djangoproject.com/en/dev/internals/release-process/#long-term-support-lts-releases
|
||||
We've also [started using milestones][github-milestones] in order to track tickets against particular releases.
|
||||
|
||||
---
|
||||
|
||||
![Labels and milestones](../img/labels-and-milestones.png)
|
||||
|
||||
**Above**: *Overview of our current use of labels and milestones in GitHub.*
|
||||
|
||||
---
|
||||
|
||||
We hope both of these changes will help make the management process more clear and obvious and help keep tickets well-organised and relevant.
|
||||
|
||||
## Next steps
|
||||
|
||||
The next planned release will be 3.0, featuring an improved and simplified serializer implementation.
|
||||
|
||||
Once again, many thanks to all the generous [backers and sponsors][kickstarter-sponsors] who've helped make this possible!
|
||||
|
||||
[lts-releases]: https://docs.djangoproject.com/en/dev/internals/release-process/#long-term-support-lts-releases
|
||||
[2-4-release-notes]: ./topics/release-notes/#240
|
||||
[view-name-and-description-settings]: ../api-guide/settings/#view-names-and-descriptions
|
||||
[client-ip-identification]: ../api-guide/throttling/#how-clients-are-identified
|
||||
[2-3-announcement]: ./topics/2.3-announcement
|
||||
[github-labels]: https://github.com/tomchristie/django-rest-framework/issues
|
||||
[github-milestones]: https://github.com/tomchristie/django-rest-framework/milestones
|
||||
[kickstarter-sponsors]: ./topics/kickstarter-announcement/#sponsors
|
||||
|
|
Loading…
Reference in New Issue
Block a user