diff doc/design.txt @ 4920:854238f78026

doc: Simplify English in detectors intro
author anatoly techtonik <techtonik@gmail.com>
date Wed, 20 Aug 2014 11:40:24 +0300
parents 609edf9de0a5
children e424987d294a
line wrap: on
line diff
--- a/doc/design.txt	Tue Aug 12 00:46:17 2014 +0300
+++ b/doc/design.txt	Wed Aug 20 11:40:24 2014 +0300
@@ -844,16 +844,16 @@
 ------------------
 
 Detectors are Python functions that are triggered on certain kinds of
-events.  The definitions of the functions live in Python modules placed
-in a directory set aside for this purpose.  Importing the Roundup
+events.  These functions are placed in a special directory which exists
+just for this purpose.  Importing the Roundup
 database module also imports all the modules in this directory, and the
 ``init()`` function of each module is called when a database is opened
 to provide it a chance to register its detectors.
 
 There are two kinds of detectors:
 
-1. an auditor is triggered just before modifying an item
-2. a reactor is triggered just after an item has been modified
+1. an `auditor` is triggered just before modifying an item
+2. a `reactor` is triggered just after an item has been modified
 
 When the Roundup database is about to perform a ``create()``, ``set()``,
 ``retire()``, or ``restore`` operation, it first calls any *auditors*

Roundup Issue Tracker: http://roundup-tracker.org/