Skip to content

Commit

Permalink
State lack of event interception in async functions
Browse files Browse the repository at this point in the history
The even interception mechanism currently works with the synchronous
generators and not with the async generators. The documentation doesn't
state this though, and has thus led to user confusion, like that
expressed in #48.

This commit adds a small statement to the documentation to clarify that
event interception currently works only with the synchronous generator
functions.

Signed-off-by: Rodrigo Tobar <rtobar@icrar.org>
  • Loading branch information
rtobar committed May 3, 2021
1 parent ed2182e commit 546502d
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,10 @@ Note that this interception
only makes sense for the ``basic_parse -> parse``,
``parse -> items`` and ``parse -> kvitems`` interactions.

Note also that event interception
is currently not supported
by the ``async`` functions.


Push interfaces
---------------
Expand Down

0 comments on commit 546502d

Please sign in to comment.