Mirrors
/
synapse-old
mirror of https://github.com/matrix-org/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Better english in docstrings are helpful.

This commit is contained in:
Erik Johnston 2014-12-16 13:32:06 +00:00
parent 35f4f6b070
commit 8133cdcc88
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
synapse/state.py
View File

@ -138,8 +138,8 @@ 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 """ Fills out the context with the `current state` of the graph. The
`current state` here is defined to be exclusive of the given event, `current state` here is defined to be the state of the event graph
i.e. its the state of the event graph just before the event. just before the event - i.e. it never includes `event`
If `event` has `auth_events` then this will also fill out the If `event` has `auth_events` then this will also fill out the
`auth_events` field on `context` from the `current_state`. `auth_events` field on `context` from the `current_state`.