Skip to content

Commit 9e04626

Browse files
committed
doc: Simplify English in detectors intro
1 parent e30b6c9 commit 9e04626

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

doc/design.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -844,16 +844,16 @@ Detector Interface
844844
------------------
845845

846846
Detectors are Python functions that are triggered on certain kinds of
847-
events. The definitions of the functions live in Python modules placed
848-
in a directory set aside for this purpose. Importing the Roundup
847+
events. These functions are placed in a special directory which exists
848+
just for this purpose. Importing the Roundup
849849
database module also imports all the modules in this directory, and the
850850
``init()`` function of each module is called when a database is opened
851851
to provide it a chance to register its detectors.
852852

853853
There are two kinds of detectors:
854854

855-
1. an auditor is triggered just before modifying an item
856-
2. a reactor is triggered just after an item has been modified
855+
1. an `auditor` is triggered just before modifying an item
856+
2. a `reactor` is triggered just after an item has been modified
857857

858858
When the Roundup database is about to perform a ``create()``, ``set()``,
859859
``retire()``, or ``restore`` operation, it first calls any *auditors*

0 commit comments

Comments
 (0)