encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-26 19:43:59 +03:00
Code Issues Packages Projects Releases Wiki Activity

Docs tweaks

Browse Source
This commit is contained in:
Tom Christie 2012-10-05 14:00:02 +01:00
parent 1a09983dfc
commit 6a15556384
2 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api-guide/responses.md
View File

@ -18,7 +18,9 @@ Unless you want to heavily customize REST framework for some reason, you should
# Methods # Methods
## Response(data, status=None, template_name=None, headers=None) ## Response()
**Signature:** `Response(data, status=None, template_name=None, headers=None)`
Unlike regular `HttpResponse` objects, you do not instantiate `Response` objects with rendered content. Instead you pass in unrendered data, which may consist of any python primatives. Unlike regular `HttpResponse` objects, you do not instantiate `Response` objects with rendered content. Instead you pass in unrendered data, which may consist of any python primatives.
@ -35,11 +37,13 @@ Arguments:
## .render() ## .render()
**Signature:** `.render()`
This methd is called to render the serialized data of the response into the final response content. When `.render()` is called, the response content will be set to the result of calling the `.render(data, accepted_media_type)` method on the accepted renderer instance. This methd is called to render the serialized data of the response into the final response content. When `.render()` is called, the response content will be set to the result of calling the `.render(data, accepted_media_type)` method on the accepted renderer instance.
You won't typically need to call `.render()` yourself, as it's handled by Django's standard response cycle. You won't typically need to call `.render()` yourself, as it's handled by Django's standard response cycle.
## Standard HTTPResponse methods ## Standard response methods
The `Response` class extends `SimpleTemplateResponse`, and all the usual methods are also available on the response. For example you can set headers on the response in the standard way: The `Response` class extends `SimpleTemplateResponse`, and all the usual methods are also available on the response. For example you can set headers on the response in the standard way:

1
docs/static/css/default.css vendored
View File

@ -154,6 +154,7 @@ body, .navbar .navbar-inner .container-fluid{
body{ body{
background: url("../img/grid.png") repeat-x; background: url("../img/grid.png") repeat-x;
background-attachment: fixed;
} }
/* custom navigation styles */ /* custom navigation styles */