summaryrefslogtreecommitdiff
path: root/docs/narr
diff options
context:
space:
mode:
authorCasey Duncan <casey.duncan@gmail.com>2010-12-08 21:56:04 -0800
committerCasey Duncan <casey.duncan@gmail.com>2010-12-08 21:56:04 -0800
commit0fd962541b8274ffae4bc2e6b20f26737186d494 (patch)
tree731982d21bc2d803d8050903fec47f7ba028f19b /docs/narr
parent8e4f1b316a7d4d8a611d71420c93cef58cf444c2 (diff)
downloadpyramid-0fd962541b8274ffae4bc2e6b20f26737186d494.tar.gz
pyramid-0fd962541b8274ffae4bc2e6b20f26737186d494.tar.bz2
pyramid-0fd962541b8274ffae4bc2e6b20f26737186d494.zip
clarify warning
Diffstat (limited to 'docs/narr')
-rw-r--r--docs/narr/static.rst19
1 files changed, 12 insertions, 7 deletions
diff --git a/docs/narr/static.rst b/docs/narr/static.rst
index 3b495a6ae..70c059e9c 100644
--- a/docs/narr/static.rst
+++ b/docs/narr/static.rst
@@ -250,12 +250,17 @@ URLs against resources made accessible by registering a custom static view.
.. warning::
- To ensure that model objects contained in the root don't "shadow"
- your static view (model objects take precedence during traversal),
- or to ensure that your root object's ``__getitem__`` is never
- called when a static resource is requested, you can refer to your
- static resources as registered above in URLs as,
- e.g. ``/@@static/foo.js``. This is completely equivalent to
- ``/static/foo.js``. See :ref:`traversal_chapter` for information
+ When adding a static view to your root object, you need to be
+ careful that there are no model objects contained in the
+ root with the same key as the view name (e.g., ``static``).
+ Model objects take precedence during traversal,
+ thus such a name collision will cause the model to "shadow"
+ your static view. To avoid this issue, and ensure that your
+ root object's ``__getitem__`` is never
+ called when a static resource is requested, you can refer to them
+ unambiguously using the ``@@`` prefix (goggles) in their URLs.
+ For the above examples you could use '/@@static/foo.js'
+ instead of '/static/foo.js' to avoid such shadowing.
+ See :ref:`traversal_chapter` for information
about "goggles" (``@@``).