Skip to content

Commit dcfc75b

Browse files
authored
Merge pull request #2792 from GromNaN/doc-event-code
Highlights event names by formatting them as code in the doc
2 parents aba7b30 + 98c0b7f commit dcfc75b

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/en/reference/events.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -128,65 +128,65 @@ The DocumentManager and UnitOfWork trigger several events during
128128
the life-time of their registered documents.
129129

130130
-
131-
preRemove - The preRemove event occurs for a given document before
131+
``preRemove`` - The preRemove event occurs for a given document before
132132
the respective DocumentManager remove operation for that document
133133
is executed.
134134
-
135-
postRemove - The postRemove event occurs for a document after the
135+
``postRemove`` - The postRemove event occurs for a document after the
136136
document has been removed. It will be invoked after the database
137137
delete operations.
138138
-
139-
prePersist - The prePersist event occurs for a given document
139+
``prePersist`` - The prePersist event occurs for a given document
140140
before the respective DocumentManager persist operation for that
141141
document is executed.
142142
-
143-
postPersist - The postPersist event occurs for a document after
143+
``postPersist`` - The postPersist event occurs for a document after
144144
the document has been made persistent. It will be invoked after the
145145
database insert operations. Generated primary key values are
146146
available in the postPersist event.
147147
-
148-
preUpdate - The preUpdate event occurs before the database update
148+
``preUpdate`` - The preUpdate event occurs before the database update
149149
operations to document data.
150150
-
151-
postUpdate - The postUpdate event occurs after the database update
151+
``postUpdate`` - The postUpdate event occurs after the database update
152152
operations to document data.
153153
-
154-
preLoad - The preLoad event occurs for a document before the
154+
``preLoad`` - The preLoad event occurs for a document before the
155155
document has been loaded into the current DocumentManager from the
156156
database or after the refresh operation has been applied to it.
157157
-
158-
postLoad - The postLoad event occurs for a document after the
158+
``postLoad`` - The postLoad event occurs for a document after the
159159
document has been loaded into the current DocumentManager from the
160160
database or after the refresh operation has been applied to it.
161161
-
162-
loadClassMetadata - The loadClassMetadata event occurs after the
162+
``loadClassMetadata`` - The loadClassMetadata event occurs after the
163163
mapping metadata for a class has been loaded from a mapping source
164164
(attributes/xml).
165165
-
166-
onClassMetadataNotFound - Loading class metadata for a particular
166+
``onClassMetadataNotFound`` - Loading class metadata for a particular
167167
requested class name failed. Manipulating the given event args instance
168168
allows providing fallback metadata even when no actual metadata exists
169169
or could be found. This event is not a lifecycle callback. Support for this
170170
event was added in MongoDB ODM 1.3.
171171
-
172-
preFlush - The preFlush event occurs before the change-sets of all
172+
``preFlush`` - The preFlush event occurs before the change-sets of all
173173
managed documents are computed. This both a lifecycle call back and
174174
and listener.
175175
-
176-
postFlush - The postFlush event occurs after the change-sets of all
176+
``postFlush`` - The postFlush event occurs after the change-sets of all
177177
managed documents are computed.
178178
-
179-
onFlush - The onFlush event occurs after the change-sets of all
179+
``onFlush`` - The onFlush event occurs after the change-sets of all
180180
managed documents are computed. This event is not a lifecycle
181181
callback.
182182
-
183-
onClear - The onClear event occurs after the UnitOfWork has had
183+
``onClear`` - The onClear event occurs after the UnitOfWork has had
184184
its state cleared.
185185
-
186-
documentNotFound - The documentNotFound event occurs when a proxy object
186+
``documentNotFound`` - The documentNotFound event occurs when a proxy object
187187
could not be initialized. This event is not a lifecycle callback.
188188
-
189-
postCollectionLoad - The postCollectionLoad event occurs just after
189+
``postCollectionLoad`` - The postCollectionLoad event occurs just after
190190
collection has been initialized (loaded) and before new elements
191191
are re-added to it.
192192

0 commit comments

Comments
 (0)