Permalink
Browse files

- Add docs for ``add_finished_callback``, ``add_response_callback``,

  ``route_path``, ``route_url``, and ``static_url`` methods to
  ``pyramid.request.Request`` API docs.
  • Loading branch information...
1 parent d5d1f0f commit 72ad3374afb491d652e2a22951b09ca399c8d0c5 @mcdonc mcdonc committed Jan 21, 2011
Showing with 26 additions and 11 deletions.
  1. +4 −0 CHANGES.txt
  2. +0 −3 TODO.txt
  3. +12 −0 docs/api/request.rst
  4. +10 −8 docs/narr/webob.rst
View
@@ -25,6 +25,10 @@ Documentation
- Added "Adding Methods to the Configurator via ``add_directive``" section to
Advanced Configuration narrative chapter.
+- Add docs for ``add_finished_callback``, ``add_response_callback``,
+ ``route_path``, ``route_url``, and ``static_url`` methods to
+ ``pyramid.request.Request`` API docs.
+
Deprecations
-------------
View
@@ -19,9 +19,6 @@ Must-Have (before 1.0)
well as -
http://blog.abourget.net/2011/1/13/pyramid-and-mako:-how-to-do-i18n-the-pylons-way/
-- Add docs for ``route_path`` and ``route_url``, etc to Request API docs (see
- also https://github.com/Pylons/pyramid/issues#issue/19).
-
- Figure out what to do with "Forms" chapter in narr docs.
Should-Have
View
@@ -113,3 +113,15 @@
request, the value of this attribute will be ``None``. See
:ref:`matched_route`.
+ .. automethod:: add_response_callback
+
+ .. automethod:: add_finished_callback
+
+ .. automethod:: route_url
+
+ .. automethod:: route_path
+
+ .. automethod:: resource_url
+
+ .. automethod:: static_url
+
View
@@ -20,9 +20,11 @@ class, which is a subclass of :class:`webob.Request`. The
Users can also return an instance of :mod:`webob.Response` directly
from a view as necessary.
-WebOb is a project separate from :app:`Pyramid` with a separate set
-of authors and a fully separate `set of documentation
-<http://pythonpaste.org/webob/>`_.
+WebOb is a project separate from :app:`Pyramid` with a separate set of
+authors and a fully separate `set of documentation
+<http://pythonpaste.org/webob/>`_. Pyramid adds some functionality to the
+standard WebOb request, which is documented in the :ref:`request_module` API
+documentation.
WebOb provides objects for HTTP requests and responses. Specifically
it does this by wrapping the `WSGI <http://wsgi.org>`_ request
@@ -109,11 +111,11 @@ instance, ``req.if_modified_since`` returns a `datetime
Special Attributes Added to the Request by :app:`Pyramid`
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-In addition to the standard :term:`WebOb` attributes, :app:`Pyramid`
-adds special attributes to every request: ``context``, ``registry``,
-``root``, ``subpath``, ``traversed``, ``view_name``, ``virtual_root``,
-``virtual_root_path``, ``session``, and ``tmpl_context``. These
-attributes are documented further within the
+In addition to the standard :term:`WebOb` attributes, :app:`Pyramid` adds
+special attributes to every request: ``context``, ``registry``, ``root``,
+``subpath``, ``traversed``, ``view_name``, ``virtual_root``,
+``virtual_root_path``, ``session``, and ``tmpl_context``, ``matchdict``, and
+``matched_route``. These attributes are documented further within the
:class:`pyramid.request.Request` API documentation.
.. index::

0 comments on commit 72ad337

Please sign in to comment.