Be more explicit on what the snapshot is

This commit is contained in:
Mark Haines 2017-03-06 18:06:02 +00:00
parent 57a6ba7f83
commit e4189ef75d

View file

@ -9,7 +9,7 @@ import (
// calculateAndStoreState calculates a snapshot of the state of a room before an event.
// Stores the snapshot of the state in the database.
// Returns a numeric ID for that snapshot.
// Returns a numeric ID for the snapshot of the state before the event.
func calculateAndStoreStateBeforeEvent(
db RoomEventDatabase, event gomatrixserverlib.Event, roomNID types.RoomNID,
) (types.StateSnapshotNID, error) {