diff options
| author | Asaf Kali <akali93@gmail.com> | 2020-09-25 15:55:25 +0300 |
|---|---|---|
| committer | Michael Howitz <mh@gocept.com> | 2020-10-02 15:15:17 +0200 |
| commit | aff62eb303e6a97697c3fff8473fd9b079a5e2c3 (patch) | |
| tree | 20894281e43c9ba2a013441ddebabb19441bd86e | |
| parent | a40fe1972982f6931a47ec5075b2a84c2b5e74a0 (diff) | |
| download | zope-event-aff62eb303e6a97697c3fff8473fd9b079a5e2c3.tar.gz | |
Add synchronous behaviour to docs
| -rw-r--r-- | README.rst | 2 | ||||
| -rw-r--r-- | docs/hacking.rst | 6 | ||||
| -rw-r--r-- | docs/usage.rst | 4 |
3 files changed, 8 insertions, 4 deletions
@@ -18,7 +18,7 @@ The ``zope.event`` package provides a simple event system, including: - An event publishing API, intended for use by applications which are unaware of any subscribers to their events. -- A very simple event-dispatching system on which more sophisticated +- A very simple synchronous event-dispatching system, on which more sophisticated event dispatching systems can be built. For example, a type-based event dispatching system that builds on ``zope.event`` can be found in ``zope.component``. diff --git a/docs/hacking.rst b/docs/hacking.rst index ad21f30..70a9f7d 100644 --- a/docs/hacking.rst +++ b/docs/hacking.rst @@ -113,7 +113,7 @@ you can see how well the tests cover the code: ... Name Stmts Exec Cover Missing ------------------------------------------ - zope.event 5 5 100% + zope.event 5 5 100% ---------------------------------------------------------------------- Ran 3 tests in 0.019s @@ -124,7 +124,7 @@ Building the documentation -------------------------- :mod:`zope.event` uses the nifty :mod:`Sphinx` documentation system -for building its docs. Using the same virtualenv you set up to run the +for building its docs. Using the same virtualenv you set up to run the tests, you can build the docs: .. code-block:: sh @@ -213,7 +213,7 @@ tool designed to run tests against multiple Python versions. It creates a ``virtualenv`` for each configured version, installs the current package and configured dependencies into each ``virtualenv``, and then runs the configured commands. - + :mod:`zope.event` configures the following :mod:`tox` environments via its ``tox.ini`` file: diff --git a/docs/usage.rst b/docs/usage.rst index 29e6b8a..b1fb729 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -115,3 +115,7 @@ To unsubscribe, simply remove a subscriber from the list: .. testcleanup:: zope.event.subscribers[:] = old_subscribers + +.. note:: The :func:`~.zope.event.notify` is synchronous, meaning it calls the + subscribers in sequential order (and not in parallel). This also means that the + process will not continue until all subscribers are done handling the event. |