aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide/reverse.md
diff options
context:
space:
mode:
authorTom Christie2012-10-02 10:40:04 +0100
committerTom Christie2012-10-02 10:40:04 +0100
commit2284e592de6315264098e77f72b816984a50d025 (patch)
tree1ab114e474de76460eafa698e7d8e0ac7edd220b /docs/api-guide/reverse.md
parenta8f6ac3f3abdcab298f73f591188012a703a65e2 (diff)
downloaddjango-rest-framework-2284e592de6315264098e77f72b816984a50d025.tar.bz2
Clean up reverse docs slightly
Diffstat (limited to 'docs/api-guide/reverse.md')
-rw-r--r--docs/api-guide/reverse.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/api-guide/reverse.md b/docs/api-guide/reverse.md
index 3fa654c0..07094e6f 100644
--- a/docs/api-guide/reverse.md
+++ b/docs/api-guide/reverse.md
@@ -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.