diff options
| author | Carlton Gibson | 2014-12-01 11:22:39 +0100 |
|---|---|---|
| committer | Carlton Gibson | 2014-12-01 11:22:39 +0100 |
| commit | ef26f43de4a0c9ac3081c06a383b5d3d4d007797 (patch) | |
| tree | bf6abcd15f0e58f4fa79a83cd4e051b8987dd311 /docs/topics/documenting-your-api.md | |
| parent | c50a42bddc66e28d624cd3caadd2d63502ac2e6e (diff) | |
| parent | 72c4ec4e189796e506655e275cd9c77abe98e1b9 (diff) | |
| download | django-rest-framework-ef26f43de4a0c9ac3081c06a383b5d3d4d007797.tar.bz2 | |
Merge branch 'master' of github.com:tomchristie/django-rest-framework
Diffstat (limited to 'docs/topics/documenting-your-api.md')
| -rw-r--r-- | docs/topics/documenting-your-api.md | 8 |
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 |
