aboutsummaryrefslogtreecommitdiffstats
path: root/docs/topics/documenting-your-api.md
diff options
context:
space:
mode:
authorTom Christie2014-11-25 16:06:45 +0000
committerTom Christie2014-11-25 16:06:45 +0000
commit306916aca126dfbe61fe9d1f0052c5cce921b669 (patch)
treee2f4036fa043ec501d5c85ae3e7e8fb91408f051 /docs/topics/documenting-your-api.md
parent64d8e3dcb6846610e1908e067962b0c8457a86f8 (diff)
parent84b34d43307704ad8240b871a48dcd6e73848cd1 (diff)
downloaddjango-rest-framework-306916aca126dfbe61fe9d1f0052c5cce921b669.tar.bz2
Merge branch 'd0ugal-mkdocs'
Diffstat (limited to 'docs/topics/documenting-your-api.md')
-rw-r--r--docs/topics/documenting-your-api.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/topics/documenting-your-api.md b/docs/topics/documenting-your-api.md
index e20f9712..d65e251f 100644
--- a/docs/topics/documenting-your-api.md
+++ b/docs/topics/documenting-your-api.md
@@ -54,7 +54,7 @@ The title that is used in the browsable API is generated from the view class nam
For example, the view `UserListView`, will be named `User List` when presented in the browsable API.
-When working with viewsets, an appropriate suffix is appended to each generated view. For example, the view set `UserViewSet` will generate views named `User List` and `User Instance`.
+When working with viewsets, an appropriate suffix is appended to each generated view. For example, the view set `UserViewSet` will generate views named `User List` and `User Instance`.
#### Setting the description
@@ -65,9 +65,9 @@ If the python `markdown` library is installed, then [markdown syntax][markdown]
class AccountListView(views.APIView):
"""
Returns a list of all **active** accounts in the system.
-
+
For more details on how accounts are activated please [see here][ref].
-
+
[ref]: http://example.com/activating-accounts
"""
@@ -84,7 +84,7 @@ You can modify the response behavior to `OPTIONS` requests by overriding the `me
def metadata(self, request):
"""
Don't include the view description in OPTIONS responses.
- """
+ """
data = super(ExampleView, self).metadata(request)
data.pop('description')
return data