]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Fixes: #5151
authorjonathan vanasco <jonathan@2xlp.com>
Mon, 27 Sep 2021 19:53:03 +0000 (15:53 -0400)
committerJonathan Vanasco <jonathan@2xlp.com>
Mon, 27 Sep 2021 21:30:25 +0000 (21:30 +0000)
document `listen=True` on `before_create`

Change-Id: I0804ee073044d879eb0decafeb1b358741d69f02

lib/sqlalchemy/sql/events.py

index a6c5c8e2862856795e2ee2c6f9d7753d3816f699..db80b51e3522d4e52b415fcb660c972776a5673d 100644 (file)
@@ -105,12 +105,17 @@ class DDLEvents(event.Events):
          event, the checkfirst flag, and other
          elements used by internal events.
 
-        :func:`.event.listen` also accepts the ``propagate=True``
+        :func:`.event.listen` accepts the ``propagate=True``
         modifier for this event; when True, the listener function will
         be established for any copies made of the target object,
         i.e. those copies that are generated when
         :meth:`_schema.Table.to_metadata` is used.
 
+        :func:`.event.listen` accepts the ``insert=True``
+        modifier for this event; when True, the listener function will
+        be prepended to the internal list of events upon discovery, and execute
+        before registered listener functions that do not pass this argument.
+
         """
 
     def after_create(self, target, connection, **kw):