aboutsummaryrefslogtreecommitdiffstats
path: root/docs/topics/documenting-your-api.md
diff options
context:
space:
mode:
authorTom Christie2014-11-25 16:27:00 +0000
committerTom Christie2014-11-25 16:27:00 +0000
commitf13c0ebe69f92ecad7e84257b3baf2ccafe69b3e (patch)
tree5de4f2bcbd973513197c809b301f05f21b9db325 /docs/topics/documenting-your-api.md
parent8c91e7b742067b6d4e4ed6d476bfe2cf5839ac8b (diff)
parentb733f85ff1e3f70e9f5dee6f52bebe861bc0f411 (diff)
downloaddjango-rest-framework-f13c0ebe69f92ecad7e84257b3baf2ccafe69b3e.tar.bz2
Merge master
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