From 74b3307978d1316603a51082b8edd9a29d2016dd Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 25 Apr 2013 20:43:37 +0100 Subject: Docs, docs, docs --- docs/topics/2.3-announcement.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) (limited to 'docs/topics') diff --git a/docs/topics/2.3-announcement.md b/docs/topics/2.3-announcement.md index 66875c82..0b80f5e2 100644 --- a/docs/topics/2.3-announcement.md +++ b/docs/topics/2.3-announcement.md @@ -4,7 +4,7 @@ REST framework 2.3 is geared towards making it easier and quicker to build your ## ViewSets & Routers -We've introduced +**TODO** ## Easier Serializers @@ -43,17 +43,17 @@ Similarly, you can now easily include the primary key in hyperlinked relationshi model = Blog fields = ('url', 'id', 'title', 'created', 'comments') -## Less complex views +## Simpler views -This release rationalises the API and implementation of the Generic views, dropping the dependancy on Django's `SingleObjectMixin` and `MultipleObjectMixin` classes, removing a number of unneeded attributes, and generally making the implementation more obvious and easy to work with. +This release rationalises the API and implementation of the generic views, dropping the dependancy on Django's `SingleObjectMixin` and `MultipleObjectMixin` classes, removing a number of unneeded attributes, and generally making the implementation more obvious and easy to work with. This improvement is reflected in improved documentation for the `GenericAPIView` base class, and should make it easier to determine how to override methods on the base class if you need to write customized subclasses. --- -## API Changes +# API Changes -### Simplified generic view classes +## Simplified generic view classes The functionality provided by `SingleObjectAPIView` and `MultipleObjectAPIView` base classes has now been moved into the base class `GenericAPIView`. The implementation of this base class is simple enough that providing subclasses for the base classes of detail and list views is somewhat unnecessary. @@ -118,9 +118,11 @@ And would have the following entry in the urlconf: Usage of the old-style attributes continues to be supported, but will raise a `PendingDeprecationWarning`. -## Other notes +--- + +# Other notes -### Explict view attributes +## Explict view attributes The usage of `model` attribute in generic Views is still supported, but it's usage is being discouraged in favour of using explict `queryset` and `serializer_class` attributes. @@ -147,7 +149,10 @@ It also makes it the usage of overridden `get_queryset()` or `get_serializer_cla """ return self.user.accounts -### Django 1.3 support +## Django 1.3 support The 2.3 release series will be the last series to provide compatiblity with Django 1.3. +## What comes next? + +The plan for the next few months is to concentrate on addressing outstanding tickets. 2.4 is likely to deal with relatively small refinements to the existing API. -- cgit v1.2.3