summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2013-04-05 07:56:58 -0700
committerMichael Merickel <michael@merickel.org>2013-04-05 07:56:58 -0700
commitdc272d12ec4fd9b8b3b54889b2ff9c7e5e3b8bd4 (patch)
tree33adc604821eb7df739347907fb99be240619667
parent84e455cf7c8d9cbfe6658548a61af2ecbbc1749e (diff)
parent5e28d6fa6f2add7bd82aecad45f24c7c4672a253 (diff)
downloadpyramid-dc272d12ec4fd9b8b3b54889b2ff9c7e5e3b8bd4.tar.gz
pyramid-dc272d12ec4fd9b8b3b54889b2ff9c7e5e3b8bd4.tar.bz2
pyramid-dc272d12ec4fd9b8b3b54889b2ff9c7e5e3b8bd4.zip
Merge pull request #970 from tshepang/diff
fix some cross-references and markup
-rw-r--r--docs/narr/scaffolding.rst10
-rw-r--r--docs/narr/security.rst2
-rw-r--r--docs/narr/subrequest.rst8
-rw-r--r--docs/narr/threadlocals.rst2
-rw-r--r--docs/narr/viewconfig.rst7
-rw-r--r--docs/narr/webob.rst2
6 files changed, 18 insertions, 13 deletions
diff --git a/docs/narr/scaffolding.rst b/docs/narr/scaffolding.rst
index 9ac579a87..0d1e3f448 100644
--- a/docs/narr/scaffolding.rst
+++ b/docs/narr/scaffolding.rst
@@ -74,11 +74,15 @@ concrete examples of scaffold directories (``zodb``, ``alchemy``, and
After you've created the template directory, add the following to the
``entry_points`` value of your distribution's ``setup.py``:
- [pyramid.scaffold]
- coolextension=coolextension.scaffolds:CoolExtensionTemplate
+.. code-block:: ini
+
+ [pyramid.scaffold]
+ coolextension=coolextension.scaffolds:CoolExtensionTemplate
For example::
+.. code-block:: python
+
def setup(
...,
entry_points = """\
@@ -95,7 +99,7 @@ because that's the name we gave it in the entry point setup. Running
output directory named ``MyStuff``.
See the module documentation for :mod:`pyramid.scaffolds` for information
-about the API of the :class:`pyramid.scaffolds.PyramidScaffold` class and
+about the API of the :class:`pyramid.scaffolds.Template` class and
related classes. You can override methods of this class to get special
behavior.
diff --git a/docs/narr/security.rst b/docs/narr/security.rst
index e91e8c542..6517fedf8 100644
--- a/docs/narr/security.rst
+++ b/docs/narr/security.rst
@@ -331,7 +331,7 @@ A principal is usually a user id, however it also may be a group id if your
authentication system provides group information and the effective
:term:`authentication policy` policy is written to respect group information.
For example, the
-:class:`pyramid.authentication.RepozeWho1AuthenicationPolicy` respects group
+:class:`pyramid.authentication.RepozeWho1AuthenticationPolicy` respects group
information if you configure it with a ``callback``.
Each ACE in an ACL is processed by an authorization policy *in the
diff --git a/docs/narr/subrequest.rst b/docs/narr/subrequest.rst
index 93ce747ee..6437bd0fa 100644
--- a/docs/narr/subrequest.rst
+++ b/docs/narr/subrequest.rst
@@ -223,16 +223,16 @@ unconditionally:
:meth:`~pyramid.config.Configurator.set_request_property`) on the subrequest
object passed as ``request``
-- causes a :class:`~pyramid.event.NewRequest` event to be sent at the
+- causes a :class:`~pyramid.events.NewRequest` event to be sent at the
beginning of request processing.
-- causes a :class:`~pyramid.event.ContextFound` event to be sent when a
+- causes a :class:`~pyramid.events.ContextFound` event to be sent when a
context resource is found.
-
+
- Ensures that the user implied by the request passed has the necessary
authorization to invoke view callable before calling it.
-- causes a :class:`~pyramid.event.NewResponse` event to be sent when the
+- causes a :class:`~pyramid.events.NewResponse` event to be sent when the
Pyramid application returns a response.
- Calls any :term:`response callback` functions defined within the subrequest's
diff --git a/docs/narr/threadlocals.rst b/docs/narr/threadlocals.rst
index 5ff70565c..a90ee4905 100644
--- a/docs/narr/threadlocals.rst
+++ b/docs/narr/threadlocals.rst
@@ -129,7 +129,7 @@ follows:
ever be called within application-specific forks of third-party
library code. The library you've forked almost certainly has
nothing to do with :app:`Pyramid`, and making it dependent on
- :app:`Pyramid` (rather than making your :mod:`pyramid`
+ :app:`Pyramid` (rather than making your :app:`pyramid`
application depend upon it) means you're forming a dependency in the
wrong direction.
diff --git a/docs/narr/viewconfig.rst b/docs/narr/viewconfig.rst
index 6f0001f61..241ce62b5 100644
--- a/docs/narr/viewconfig.rst
+++ b/docs/narr/viewconfig.rst
@@ -908,10 +908,11 @@ per :ref:`protecting_views`.
.. _debug_notfound_section:
-:exc:`NotFound` Errors
-~~~~~~~~~~~~~~~~~~~~~~
+:exc:`~pyramid.exceptions.NotFound` Errors
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-It's useful to be able to debug :exc:`NotFound` error responses when they
+It's useful to be able to debug :exc:`~pyramid.exceptions.NotFound`
+error responses when they
occur unexpectedly due to an application registry misconfiguration. To debug
these errors, use the ``PYRAMID_DEBUG_NOTFOUND`` environment variable or the
``pyramid.debug_notfound`` configuration file setting. Details of why a view
diff --git a/docs/narr/webob.rst b/docs/narr/webob.rst
index 02c03c8db..c0ca450b1 100644
--- a/docs/narr/webob.rst
+++ b/docs/narr/webob.rst
@@ -487,7 +487,7 @@ module.
Each class is named ``pyramid.httpexceptions.HTTP*``, where ``*`` is the
reason for the error. For instance,
:class:`pyramid.httpexceptions.HTTPNotFound` subclasses
-:class:`pyramid.Response`, so you can manipulate the instances in the same
+:class:`pyramid.response.Response`, so you can manipulate the instances in the same
way. A typical example is:
.. code-block:: python