Browse Source

Added examples to HttpRequest.build_absolute_uri() docs.

Adam Johnson 6 years ago
parent
commit
b71e3d635a
1 changed files with 9 additions and 4 deletions
  1. 9 4
      docs/ref/request-response.txt

+ 9 - 4
docs/ref/request-response.txt

@@ -293,16 +293,21 @@ Methods
 
 
     Example: ``"/minfo/music/bands/the_beatles/?print=true"``
     Example: ``"/minfo/music/bands/the_beatles/?print=true"``
 
 
-.. method:: HttpRequest.build_absolute_uri(location)
+.. method:: HttpRequest.build_absolute_uri(location=None)
 
 
     Returns the absolute URI form of ``location``. If no location is provided,
     Returns the absolute URI form of ``location``. If no location is provided,
     the location will be set to ``request.get_full_path()``.
     the location will be set to ``request.get_full_path()``.
 
 
     If the location is already an absolute URI, it will not be altered.
     If the location is already an absolute URI, it will not be altered.
     Otherwise the absolute URI is built using the server variables available in
     Otherwise the absolute URI is built using the server variables available in
-    this request.
-
-    Example: ``"https://example.com/music/bands/the_beatles/?print=true"``
+    this request. For example:
+
+    >>> request.build_absolute_uri()
+    'https://example.com/music/bands/the_beatles/?print=true'
+    >>> request.build_absolute_uri('/bands/')
+    'https://example.com/bands/'
+    >>> request.build_absolute_uri('https://example2.com/bands/')
+    'https://example2.com/bands/'
 
 
     .. note::
     .. note::