diff options
| author | Adam Johnson <me@adamj.eu> | 2018-12-30 00:44:45 +0000 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2018-12-29 19:45:01 -0500 |
| commit | 65ccb1b7e4be278f5d14a97d50bc8a4e94b3001d (patch) | |
| tree | 57183268099df76bf2ee799ec5fe9a9413cdd9ea | |
| parent | 400dac7b698ecaaaaee989188ef89cf42f6d04b0 (diff) | |
[2.1.x] Added examples to HttpRequest.build_absolute_uri() docs.
Backport of b71e3d635a5731ec02469822694d06d964007f9b from master.
| -rw-r--r-- | docs/ref/request-response.txt | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/ref/request-response.txt b/docs/ref/request-response.txt index 6ad879079f..9e445ee4ff 100644 --- a/docs/ref/request-response.txt +++ b/docs/ref/request-response.txt @@ -293,16 +293,21 @@ Methods 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, the location will be set to ``request.get_full_path()``. 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 - this request. + this request. For example: - Example: ``"https://example.com/music/bands/the_beatles/?print=true"`` + >>> 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:: |