From 5e3357c70e419c244156ac3885b2cf784b5b3fc0 Mon Sep 17 00:00:00 2001 From: Mike Bayer Date: Tue, 25 Jan 2022 09:14:32 -0500 Subject: [PATCH] replace "e.g.::" with more context regarding attribute events example Fixes: #7613 Change-Id: I28a9577587399c41afd53fbd026003667654c3fc --- lib/sqlalchemy/orm/events.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/lib/sqlalchemy/orm/events.py b/lib/sqlalchemy/orm/events.py index d31bff31a2..dc049891a1 100644 --- a/lib/sqlalchemy/orm/events.py +++ b/lib/sqlalchemy/orm/events.py @@ -2154,7 +2154,8 @@ class AttributeEvents(event.Events): These are typically defined on the class-bound descriptor for the target class. - e.g.:: + For example, to register a listener that will receive the + :meth:`_orm.AttributeEvents.append` event:: from sqlalchemy import event @@ -2165,7 +2166,8 @@ class AttributeEvents(event.Events): Listeners have the option to return a possibly modified version of the value, when the :paramref:`.AttributeEvents.retval` flag is passed to - :func:`.event.listen` or :func:`.event.listens_for`:: + :func:`.event.listen` or :func:`.event.listens_for`, such as below, + illustrated using the :meth:`_orm.AttributeEvents.set` event:: def validate_phone(target, value, oldvalue, initiator): "Strip non-numeric characters from a phone number" -- 2.47.2