From 3bbe869dd7afbf089f32eed7f2ae17e8978c8035 Mon Sep 17 00:00:00 2001 From: Bruce Sutherland Date: Wed, 21 Jan 2015 14:09:30 +0900 Subject: [PATCH] Clarify contents of request properties. Change URL to IRI and update examples to include extended characters. --- docs/api.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 6c2ab0cf..c7fdda4a 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -92,24 +92,24 @@ Incoming Request Data .. attribute:: base_url .. attribute:: url_root - Provides different ways to look at the current URL. Imagine your - application is listening on the following URL:: + Provides different ways to look at the current `IRI`_. Imagine your + application is listening on the following IRI:: http://www.example.com/myapplication - And a user requests the following URL:: + And a user requests the following IRI:: - http://www.example.com/myapplication/page.html?x=y + http://www.example.com/myapplication/日本/page.html?x=y In this case the values of the above mentioned attributes would be the following: ============= ====================================================== - `path` ``/page.html`` - `full_path` ``/page.html?x=y`` + `path` ``/日本/page.html`` + `full_path` ``/日本/page.html?x=y`` `script_root` ``/myapplication`` - `base_url` ``http://www.example.com/myapplication/page.html`` - `url` ``http://www.example.com/myapplication/page.html?x=y`` + `base_url` ``http://www.example.com/myapplication/日本/page.html`` + `url` ``http://www.example.com/myapplication/日本/page.html?x=y`` `url_root` ``http://www.example.com/myapplication/`` ============= ======================================================