Michael Foord avatar Michael Foord committed bf83ac4

Update to descriptions.txt

Comments (0)

Files changed (1)

 message
 -------
 
-This event is fired when a test runner receives a message to send. It is useful for customising output sent by plugins using the messaging API.
+This event is fired when a test runner receives a message to send.
 
 The ``MessageEvent`` event objects have the following attributes:
 
 * ``message`` - the message to be output
 * ``verbosity`` - a tuple of verbosities (even if there is only one), integers or strings - but 'quiet', 'normal' and 'verbose' will already have been converted into their integer equivalents
 
+All messages sent by the ``TextTestResult`` and ``TextTestRunner`` go through this API, so you can use it for customising output of a test run - for example logging to a file.
+
 If the message is handled then what happens next depends on the return value of the handler function. If the handler returns True the message will be written immediately. If the handler returns False the message will be discarded.
 
 Handler functions may modify ``event.message`` and ``event.verbosity`` and the modified values will be used.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.