From 2284e592de6315264098e77f72b816984a50d025 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 2 Oct 2012 10:40:04 +0100 Subject: [PATCH] Clean up reverse docs slightly --- docs/api-guide/reverse.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/api-guide/reverse.md b/docs/api-guide/reverse.md index 3fa654c09..07094e6ff 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.