Skip to content

Commit

Permalink
docs for KEYDOWN post behaviour
Browse files Browse the repository at this point in the history
  • Loading branch information
Robert Pfeiffer committed Aug 24, 2020
1 parent b7293ea commit 095b35e
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/reST/ref/event.rst
Expand Up @@ -346,6 +346,13 @@ Events reserved for :mod:`pygame.midi` use.

If the event queue is full a :exc:`pygame.error` is raised.

Caution: In pygame 2.0, calling this function with event types defined by
pygame (such as ``pygame.KEYDOWN``) may put events into the SDL2 event queue.
In this case, an error may be raised if expected properties of that event
(defined in the table at the top) are missing, and unexpected properties may
be silently omitted. In order to avoid this behaviour, custom event
properties should be used with custom event types.

.. ## pygame.event.post ##
.. function:: custom_type
Expand Down

0 comments on commit 095b35e

Please sign in to comment.