aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/api-guide/responses.md8
-rw-r--r--docs/static/css/default.css1
2 files changed, 7 insertions, 2 deletions
diff --git a/docs/api-guide/responses.md b/docs/api-guide/responses.md
index d8f8e97c..724428f8 100644
--- a/docs/api-guide/responses.md
+++ b/docs/api-guide/responses.md
@@ -18,7 +18,9 @@ Unless you want to heavily customize REST framework for some reason, you should
# 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.
@@ -35,11 +37,13 @@ Arguments:
## .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.
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:
diff --git a/docs/static/css/default.css b/docs/static/css/default.css
index 28cd9a19..5a73fb99 100644
--- a/docs/static/css/default.css
+++ b/docs/static/css/default.css
@@ -154,6 +154,7 @@ body, .navbar .navbar-inner .container-fluid{
body{
background: url("../img/grid.png") repeat-x;
+ background-attachment: fixed;
}
/* custom navigation styles */