diff --git a/docs/source/quick_start.rst b/docs/source/quick_start.rst index 3b345fe..2907885 100644 --- a/docs/source/quick_start.rst +++ b/docs/source/quick_start.rst @@ -113,7 +113,7 @@ Running the Application The base project template creates the configuration file with the basic settings you need to run your Pecan application in -``config.py``. This file includes the host and port to run the serves +``config.py``. This file includes the host and port to run the server on, the location where your controllers and templates are stored on disk, and the name of the directory containing any static files. diff --git a/docs/source/routing.rst b/docs/source/routing.rst index 53ba4d8..9c02a63 100644 --- a/docs/source/routing.rst +++ b/docs/source/routing.rst @@ -193,7 +193,7 @@ The :func:`_lookup` special method provides a way to process a portion of a URL, and then return a new controller object to route to for the remainder. A :func:`_lookup` method may accept one or more arguments, segments -chunks of the URL path to be processed (split on +of the URL path to be processed (split on ``/``). :func:`_lookup` should also take variable positional arguments representing the rest of the path, and it should include any portion of the path it does not process in its return value. The example below diff --git a/docs/source/secure_controller.rst b/docs/source/secure_controller.rst index ba24149..090b512 100644 --- a/docs/source/secure_controller.rst +++ b/docs/source/secure_controller.rst @@ -61,7 +61,7 @@ To secure a class, invoke with two arguments:: unclassified = UnclassifiedController() -``SecureControler`` +``SecureController`` ------------------- Alternatively, the same functionality can also be accomplished by diff --git a/docs/source/testing.rst b/docs/source/testing.rst index 8e8cb93..481166e 100644 --- a/docs/source/testing.rst +++ b/docs/source/testing.rst @@ -6,7 +6,7 @@ Tests can live anywhere in your Pecan project as long as the test runner can discover them. Traditionally, they exist in a package named ``myapp.tests``. The suggested mechanism for unit and integration testing of a Pecan application -is the ``unittest`` module. +is the :mod:`unittest` module. Test Discovery and Other Tools ------------------------------ @@ -120,7 +120,7 @@ A functional test for this controller might look something like In addition to :attr:`webtest.TestResponse.body`, Pecan also provides :attr:`webtest.TestResponse.namespace`, which represents the template namespace returned from the controller, and :attr:`webtest.TestResponse.template_name`, which -yields the name of the template used. +contains the name of the template used. ::