encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-08-02 19:40:13 +03:00
Code Issues Packages Projects Releases Wiki Activity

Adjust wording

Browse Source
This commit is contained in:
Carlton Gibson 2018-02-22 16:49:50 +01:00
parent 51884ab962
commit a0528fdaf5
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/api-guide/routers.md
View File

@ -73,7 +73,7 @@ Alternatively you can use Django's `include` function, like so…
]
To include the router URL patterns with an application namespace pass a
`(router.urls, app_name)` 2-tuple to `include`.
`(router.urls, 'app_name')` 2-tuple to `include`.
For example:
@ -82,9 +82,8 @@ For example:
url(r'^api/', include((router.urls, 'app_name'))),
]
(`include` also allows an optional `namespace` parameter to also create an _instance namespace_.
This defaults to `None` and will be set to `app_name` if not provided.
See Django's [URL namespaces docs][url-namespace-docs] for more details.)
(You may additionally pass an optional `namespace` parameter to `include` to also
create an _instance namespace_. See Django's [URL namespaces docs][url-namespace-docs] for more details.)
If using namespacing with hyperlinked serializers you'll also need to ensure that any `view_name` parameters on the serializers correctly reflect the namespace.
In the example above you'd need to include a parameter such as `view_name='app_name:user-detail'` for serializer fields hyperlinked to the user detail view.