summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2011-07-15 15:48:32 -0400
committerChris McDonough <chrism@plope.com>2011-07-15 15:48:32 -0400
commit3cf8bce5af17652d3c4f2644a03f9e29a11d50e4 (patch)
treea9b67d11621780b53769aef1cff9e58af00ac359
parent7a5f5612791210081db430aa707ed146a8e2c0e9 (diff)
downloadpyramid-3cf8bce5af17652d3c4f2644a03f9e29a11d50e4.tar.gz
pyramid-3cf8bce5af17652d3c4f2644a03f9e29a11d50e4.tar.bz2
pyramid-3cf8bce5af17652d3c4f2644a03f9e29a11d50e4.zip
add not-for-civilians warnings
-rw-r--r--pyramid/config.py11
1 files changed, 9 insertions, 2 deletions
diff --git a/pyramid/config.py b/pyramid/config.py
index 057282838..29da51875 100644
--- a/pyramid/config.py
+++ b/pyramid/config.py
@@ -463,7 +463,7 @@ class Configurator(object):
:meth:`pyramid.config.Configuration.commit` is called (or executed
immediately if ``autocommit`` is ``True``).
- .. note:: This method is typically only used by :app:`Pyramid`
+ .. warning:: This method is typically only used by :app:`Pyramid`
framework extension authors, not by :app:`Pyramid` application
developers.
@@ -607,6 +607,10 @@ class Configurator(object):
"""
Add a directive method to the configurator.
+ .. warning:: This method is typically only used by :app:`Pyramid`
+ framework extension authors, not by :app:`Pyramid` application
+ developers.
+
Framework extenders can add directive methods to a configurator by
instructing their users to call ``config.add_directive('somename',
'some.callable')``. This will make ``some.callable`` accessible as
@@ -808,11 +812,14 @@ class Configurator(object):
def derive_view(self, view, attr=None, renderer=None):
"""
-
Create a :term:`view callable` using the function, instance,
or class (or :term:`dotted Python name` referring to the same)
provided as ``view`` object.
+ .. warning:: This method is typically only used by :app:`Pyramid`
+ framework extension authors, not by :app:`Pyramid` application
+ developers.
+
This is API is useful to framework extenders who create
pluggable systems which need to register 'proxy' view
callables for functions, instances, or classes which meet the