From c5f24b2957a2a7569d70930ac5bc630cc5aaac55 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 18 Jan 2010 18:07:12 +0000 Subject: Prep for b1 Merge a bunch of paper-based docs fixes Configure logging during bfgshell. --- docs/tutorials/bfgwiki/authorization.rst | 4 ++-- docs/tutorials/bfgwiki/basiclayout.rst | 14 +++++++------- docs/tutorials/bfgwiki/installation.rst | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) (limited to 'docs/tutorials/bfgwiki') diff --git a/docs/tutorials/bfgwiki/authorization.rst b/docs/tutorials/bfgwiki/authorization.rst index b2c5330f6..1b83d3651 100644 --- a/docs/tutorials/bfgwiki/authorization.rst +++ b/docs/tutorials/bfgwiki/authorization.rst @@ -50,8 +50,8 @@ content: :language: python The ``groupfinder`` function defined here is an authorization policy -"callback"; it is a a callable that accepts a userid and a request. -If the userid exists in the set of users known by the system, the +"callback"; it is a callable that accepts a userid and a request. If +the userid exists in the set of users known by the system, the callback will return a sequence of group identifiers (or an empty sequence if the user isn't a member of any groups). If the userid *does not* exist in the system, the callback will return ``None``. diff --git a/docs/tutorials/bfgwiki/basiclayout.rst b/docs/tutorials/bfgwiki/basiclayout.rst index 213f238fd..c2b2ebd4b 100644 --- a/docs/tutorials/bfgwiki/basiclayout.rst +++ b/docs/tutorials/bfgwiki/basiclayout.rst @@ -106,32 +106,32 @@ function within the file named ``run.py``: :linenos: :language: py -#. *Lines 1-3*. Perform some dependency imports. +#. *Lines 1-2*. Perform some dependency imports. -#. *Line 11*. Get the ZODB configuration from the ``tutorial.ini`` +#. *Line 12*. Get the ZODB configuration from the ``tutorial.ini`` file's ``[app:main]`` section represented by the ``settings`` dictionary passed to our ``app`` function. This will be a URI (something like ``file:///path/to/Data.fs``). -#. *Line 14*. We create a "finder" object using the +#. *Line 15*. We create a "finder" object using the ``PersistentApplicationFinder`` helper class, passing it the ZODB URI and the "appmaker" we've imported from ``models.py``. -#. *Lines 15 - 16*. We create a :term:`root factory` which uses the +#. *Lines 16 - 17*. We create a :term:`root factory` which uses the finder to return a ZODB root object. -#. *Line 17*. We construct a :term:`Configurator` with a :term:`root +#. *Line 18*. We construct a :term:`Configurator` with a :term:`root factory` and the settings keywords parsed by PasteDeploy. The root factory is named ``get_root``. -#. *Lines 18-20*. Begin configuration using the ``begin`` method of +#. *Lines 19-21*. Begin configuration using the ``begin`` method of the :meth:`repoze.bfg.configuration.Configurator` class, load the ``configure.zcml`` file from our package using the :meth:`repoze.bfg.configuration.Configurator.load_zcml` method, and end configuration using the :meth:`repoze.bfg.configuration.Configurator.end` method. -#. *Line 21*. Use the +#. *Line 22*. Use the :meth:`repoze.bfg.configuration.Configurator.make_wsgi_app` method to return a :term:`WSGI` application. diff --git a/docs/tutorials/bfgwiki/installation.rst b/docs/tutorials/bfgwiki/installation.rst index fcfaff642..4f1e5a34f 100644 --- a/docs/tutorials/bfgwiki/installation.rst +++ b/docs/tutorials/bfgwiki/installation.rst @@ -112,7 +112,7 @@ Preparation, Windows .. code-block:: bat - c:\bigfntut> Scripts/easy_install -i \ + c:\bigfntut> Scripts\easy_install -i \ http://dist.repoze.org/bfg/current/simple repoze.bfg #. Use ``easy_install`` to install ``docutils``, ``repoze.tm``, -- cgit v1.2.3