Matrix-Mirrors/forked-synapse
1
0
Fork 0
mirror of https://mau.dev/maunium/synapse.git synced 2024-10-01 01:36:05 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add basic docstring to annotate_context_with_state

Browse Source
This commit is contained in:
Erik Johnston 2014-12-16 13:07:48 +00:00
parent 3c77d13aa5
commit 4afac88390
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
synapse/state.py
View File

@ -137,6 +137,17 @@ class StateHandler(object):
@defer.inlineCallbacks @defer.inlineCallbacks
def annotate_context_with_state(self, event, context, old_state=None): def annotate_context_with_state(self, event, context, old_state=None):
""" Fills out the context with the `current state` of the graph. The
`current state` here is defined to be exclusive of the given event,
i.e. its the state of the event graph just before the event.
If `event` has `auth_events` then this will also fill out the
`auth_events` field on `context` from the `current_state`.
Args:
event (EventBase)
context (EventContext)
"""
yield run_on_reactor() yield run_on_reactor()
if old_state: if old_state: