aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTom Christie2013-04-29 12:08:21 +0100
committerTom Christie2013-04-29 12:08:21 +0100
commit70831ad0bb62e88ef93e8c1815444ac709eb9883 (patch)
tree9c5f14992bd7d86863294c4e8230d5ebff6299bf
parent018d8b8dced31309196496e625cf8a746b98d65e (diff)
downloaddjango-rest-framework-70831ad0bb62e88ef93e8c1815444ac709eb9883.tar.bz2
Docs tweaks
-rw-r--r--README.md2
-rw-r--r--docs/topics/2.3-announcement.md8
2 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index c76db7ec..ba669c88 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@
# Overview
-Django REST framework is a lightweight library that makes it easy to build Web APIs. It is designed as a modular and easy to customize architecture, based on Django's class based views.
+Django REST framework is a powerful and flexible toolkit that makes it easy to build Web APIs.
Web APIs built using REST framework are fully self-describing and web browseable - a huge useability win for your developers. It also supports a wide range of media types, authentication and permission policies out of the box.
diff --git a/docs/topics/2.3-announcement.md b/docs/topics/2.3-announcement.md
index 554728ae..e1bcde05 100644
--- a/docs/topics/2.3-announcement.md
+++ b/docs/topics/2.3-announcement.md
@@ -124,6 +124,14 @@ Usage of the old-style attributes continues to be supported, but will raise a `P
For most cases APIs using model fields will behave as previously, however if you are using a custom renderer, not provided by REST framework, then you may now need to add support for rendering `Decimal` instances to your renderer implmentation.
+## View names and descriptions
+
+The mechanics of how view names and descriptions are generated from the docstring and classname has been modified and cleaned up somewhat.
+
+If you've been customizing this behavior, for example perhaps to use `rst` markup for the browseable API, then you'll need to take a look at the implementation to see what updates you need to make.
+
+Note that the relevant methods have always been private APIs, and the docstrings called them out as intended to be deprecated.
+
---
# Other notes