summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorcewing <cris@crisewing.com>2016-06-03 16:18:34 -0700
committercewing <cris@crisewing.com>2016-06-09 11:20:55 -0700
commit6fcca68c34057200e7d7bebbdae678e4c0216dd6 (patch)
tree00547f2124a46ee7f0ad3bc35b3eb9b7868dc20f /docs
parent02c5ba3a2cc09948ff49fd9f7c1bcba65050893a (diff)
downloadpyramid-6fcca68c34057200e7d7bebbdae678e4c0216dd6.tar.gz
pyramid-6fcca68c34057200e7d7bebbdae678e4c0216dd6.tar.bz2
pyramid-6fcca68c34057200e7d7bebbdae678e4c0216dd6.zip
fix decorator configuration section
Diffstat (limited to 'docs')
-rw-r--r--docs/narr/introduction.rst24
1 files changed, 9 insertions, 15 deletions
diff --git a/docs/narr/introduction.rst b/docs/narr/introduction.rst
index bbe7df537..41bc7ead3 100644
--- a/docs/narr/introduction.rst
+++ b/docs/narr/introduction.rst
@@ -97,13 +97,11 @@ in very similar ways.
See also :ref:`firstapp_chapter`.
-Decorator-based configuration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Configure applications with decorators
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you like the idea of framework configuration statements living next to the
-code it configures, so you don't have to constantly switch between files to
-refer to framework configuration when adding new code, you can use Pyramid
-decorators to localize the configuration. For example:
+Pyramid allows you to keep your configuration right next to your code. That way
+you don't have to switch files to see your configuration. For example:
.. code-block:: python
@@ -114,15 +112,11 @@ decorators to localize the configuration. For example:
def fred_view(request):
return Response('fred')
-However, unlike some other systems, using decorators for Pyramid configuration
-does not make your application difficult to extend, test, or reuse. The
-:class:`~pyramid.view.view_config` decorator, for example, does not actually
-*change* the input or output of the function it decorates, so testing it is a
-"WYSIWYG" operation. You don't need to understand the framework to test your
-own code. You just behave as if the decorator is not there. You can also
-instruct Pyramid to ignore some decorators, or use completely imperative
-configuration instead of decorators to add views. Pyramid decorators are inert
-instead of eager. You detect and activate them with a :term:`scan`.
+However, using Pyramid configuration decorators does not change your code. It
+remains easy to extend, test or reuse. You can test your code as if the
+decorators were not there. You can instruct the framework to ignore some
+decorators. You can even use an imperative style to write your configuration,
+skipping decorators entirely.
Example: :ref:`mapping_views_using_a_decorator_section`.