summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2010-12-23 13:20:39 -0500
committerChris McDonough <chrism@plope.com>2010-12-23 13:20:39 -0500
commita827e04ac308f8005f674bef01d70a842be708cf (patch)
treee7a8b8c40e19f77da714ad07613f2fddbda56312 /docs
parent98b0afb7bbf4e58cfeaa7a2e970b35069751284a (diff)
downloadpyramid-a827e04ac308f8005f674bef01d70a842be708cf.tar.gz
pyramid-a827e04ac308f8005f674bef01d70a842be708cf.tar.bz2
pyramid-a827e04ac308f8005f674bef01d70a842be708cf.zip
note __resource_url__ requirements
Diffstat (limited to 'docs')
-rw-r--r--docs/narr/resources.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/narr/resources.rst b/docs/narr/resources.rst
index f90b1eb12..ac88afdfd 100644
--- a/docs/narr/resources.rst
+++ b/docs/narr/resources.rst
@@ -324,6 +324,11 @@ would have been what was returned anyway, but your code can perform arbitrary
logic as necessary. For example, your code may wish to override the hostname
or port number of the generated URL.
+Note that the URL generated by ``__resource_url__`` should be fully
+qualified, should end in a slash, and should not contain any query string or
+anchor elements (only path elements) to work best with
+:func:`pyramid.url.resource_url`.
+
Generating the Path To a Resource
---------------------------------