Better english in docstrings are helpful.

pull/25/head
Erik Johnston 2014-12-16 13:32:06 +00:00
parent 35f4f6b070
commit 8133cdcc88
1 changed files with 2 additions and 2 deletions

View File

@ -138,8 +138,8 @@ class StateHandler(object):
@defer.inlineCallbacks
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.
`current state` here is defined to be the state of the event graph
just before the event - i.e. it never includes `event`
If `event` has `auth_events` then this will also fill out the
`auth_events` field on `context` from the `current_state`.