encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-22 17:47:04 +03:00
Code Issues Packages Projects Releases Wiki Activity

Clean up reverse docs slightly

Browse Source
This commit is contained in:
Tom Christie 2012-10-02 10:40:04 +01:00
parent a8f6ac3f3a
commit 2284e592de
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api-guide/reverse.md
View File

@ -19,7 +19,9 @@ REST framework provides two utility functions to make it more simple to return a
There's no requirement for you to use them, but if you do then the self-describing API will be able to automatically hyperlink it's output for you, which makes browsing the API much easier.
## reverse(viewname, request, *args, **kwargs)
## reverse
**Signature:** `reverse(viewname, request, *args, **kwargs)`
Has the same behavior as [`django.core.urlresolvers.reverse`][reverse], except that it returns a fully qualified URL, using the request to determine the host and port.
@ -34,7 +36,9 @@ Has the same behavior as [`django.core.urlresolvers.reverse`][reverse], except t
}
return Response(content)
## reverse_lazy(viewname, request, *args, **kwargs)
## reverse_lazy
**Signature:** `reverse_lazy(viewname, request, *args, **kwargs)`
Has the same behavior as [`django.core.urlresolvers.reverse_lazy`][reverse-lazy], except that it returns a fully qualified URL, using the request to determine the host and port.