diff options
| author | Tom Christie | 2012-10-13 15:34:38 +0100 |
|---|---|---|
| committer | Tom Christie | 2012-10-13 15:34:38 +0100 |
| commit | b3477b3b6c1431a03089d68828c13568d02dc990 (patch) | |
| tree | e988183576a8f2d75c8515323ea4adef84e89413 /docs/topics | |
| parent | fe5db419491fb400d4f7211f57225719087d7c36 (diff) | |
| download | django-rest-framework-b3477b3b6c1431a03089d68828c13568d02dc990.tar.bz2 | |
Docs tweaks
Diffstat (limited to 'docs/topics')
| -rw-r--r-- | docs/topics/browsable-api.md | 2 | ||||
| -rw-r--r-- | docs/topics/migration.md | 8 |
2 files changed, 7 insertions, 3 deletions
diff --git a/docs/topics/browsable-api.md b/docs/topics/browsable-api.md index ed27752f..df0eb353 100644 --- a/docs/topics/browsable-api.md +++ b/docs/topics/browsable-api.md @@ -1,4 +1,4 @@ -# Working with the Browsable API +# The Browsable API API may stand for Application *Programming* Interface, but humans have to be able to read the APIs, too; someone has to do the programming. Django REST Framework supports generating human-friendly HTML output for each resource when the `HTML` format is requested. These pages allow for easy browsing of resources, as well as forms for submitting data to the resources using `POST`, `PUT`, and `DELETE`. diff --git a/docs/topics/migration.md b/docs/topics/migration.md index f6a301b8..25fc9074 100644 --- a/docs/topics/migration.md +++ b/docs/topics/migration.md @@ -1,5 +1,9 @@ # 2.0 Migration Guide +> Move fast and break things +> +> — Mark Zuckerberg, [the Hacker Way][cite]. + REST framework 2.0 introduces a radical redesign of the core components, and a large number of backwards breaking changes. ### Serialization redesign. @@ -21,7 +25,7 @@ REST framework 2.0's request-response cycle is now much less complex. * Responses inherit from `SimpleTemplateResponse`, allowing rendering to be delegated to the response, not handled by the view. * Requests extend the regular `HttpRequest`, allowing authentication and parsing to be delegated to the request, not handled by the view. -### Renamed attribnutes & classes. +### Renamed attributes & classes. Various attributes and classes have been renamed in order to fit in better with Django's conventions. @@ -82,4 +86,4 @@ Let's start to re-write this for REST framework 2.0. model = Comment fields = ('username', 'comment', 'created', 'rating', 'url', 'blogpost') - +[cite]: http://www.wired.com/business/2012/02/zuck-letter/ |