stackforge/pecan
Code Issues Proposed changes

Fixing a few .rst formatting issues.

Browse Source
This commit is contained in:
Ryan Petrello
2012-03-14 22:19:13 -07:00
parent 8b8c166b66
commit 37bc24e7c0
3 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/source/databases.rst
View File

@@ -1,14 +1,14 @@
.. _databases: .. _databases:
Working with Databases, Transactions, and ORM's Working with Databases, Transactions, and ORM's
============= ===============================================
Out of the box, Pecan provides no opinionated support for working with databases, Out of the box, Pecan provides no opinionated support for working with databases,
but it's easy to hook into your ORM of choice with minimal effort. This article but it's easy to hook into your ORM of choice with minimal effort. This article
details best practices for integrating the popular Python ORM, SQLAlchemy, into details best practices for integrating the popular Python ORM, SQLAlchemy, into
your Pecan project. your Pecan project.
``init_model`` and Preparing Your Model ``init_model`` and Preparing Your Model
---------------- ---------------------------------------
Pecan's default quickstart project includes an empty stub directory for implementing Pecan's default quickstart project includes an empty stub directory for implementing
your model as you see fit:: your model as you see fit::
@@ -96,7 +96,8 @@ Here's what a sample Pecan configuration file with database bindings might look
Session.remove() Session.remove()
Binding Within the Application Binding Within the Application
---------------- ------------------------------
There are several approaches that can be taken to wrap your application's requests with calls There are several approaches that can be taken to wrap your application's requests with calls
to appropriate model function calls. One approach is WSGI middleware. We also recommend to appropriate model function calls. One approach is WSGI middleware. We also recommend
Pecan :ref:`hooks`. Pecan comes with ``TransactionHook``, a hook which can Pecan :ref:`hooks`. Pecan comes with ``TransactionHook``, a hook which can
@@ -146,7 +147,8 @@ manner:
Also note that there is a useful ``@after_commit`` decorator provided in :ref:`pecan_decorators`. Also note that there is a useful ``@after_commit`` decorator provided in :ref:`pecan_decorators`.
Splitting Reads and Writes Splitting Reads and Writes
---------------- --------------------------
Employing the strategy above with ``TransactionHook`` makes it very simple to split database Employing the strategy above with ``TransactionHook`` makes it very simple to split database
reads and writes based upon HTTP methods (i.e., GET/HEAD requests are read-only and would potentially reads and writes based upon HTTP methods (i.e., GET/HEAD requests are read-only and would potentially
be routed to a read-only database slave, while POST/PUT/DELETE requests require writing, and be routed to a read-only database slave, while POST/PUT/DELETE requests require writing, and

2
docs/source/hooks.rst
View File

@@ -45,7 +45,7 @@ was chosen by Pecan's routing.
``on_error`` is passed a shared state object **and** the original exception. ``on_error`` is passed a shared state object **and** the original exception.
Attaching Hooks Attaching Hooks
-------------- ---------------
Hooks can be attached in a project-wide manner by specifying a list of hooks Hooks can be attached in a project-wide manner by specifying a list of hooks
in your project's ``app.py`` file:: in your project's ``app.py`` file::

4
docs/source/sessions.rst
View File

@@ -1,7 +1,7 @@
.. _session: .. _session:
Working with Sessions and User Authentication Working with Sessions and User Authentication
============= =============================================
Out of the box, Pecan provides no opinionated support for managing user sessions, Out of the box, Pecan provides no opinionated support for managing user sessions,
but it's easy to hook into your session framework of choice with minimal but it's easy to hook into your session framework of choice with minimal
effort. effort.
@@ -10,7 +10,7 @@ This article details best practices for integrating the popular session
framework, `Beaker <http://beaker.groovie.org>`_, into your Pecan project. framework, `Beaker <http://beaker.groovie.org>`_, into your Pecan project.
Setting up Session Management Setting up Session Management
---------------- -----------------------------
There are several approaches that can be taken to set up session management. There are several approaches that can be taken to set up session management.
One approach is WSGI middleware. Another is Pecan :ref:`hooks`. One approach is WSGI middleware. Another is Pecan :ref:`hooks`.