Merge pull request #2159 from jimmycuadra/reference-hash-purpose

turt2live · web-flow · commit 7b0f5ea77b76 · 2019-07-09T16:27:44.000-06:00
Clarify the purpose of reference hashes.
diff --git a/changelogs/server_server/newsfragments/2159.clarification b/changelogs/server_server/newsfragments/2159.clarification
@@ -0,0 +1 @@
+Clarify the purpose of reference hashes.
diff --git a/specification/server_server_api.rst b/specification/server_server_api.rst
@@ -1134,7 +1134,9 @@ Calculating the reference hash for an event
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The *reference hash* of an event covers the essential fields of an event,
-including content hashes. It is calculated as follows.
+including content hashes. It is used for event identifiers in some room versions.
+See the `room version specification`_ for more information. It is calculated as
+follows.
 
 1. The event is put through the redaction algorithm.
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Clarify the purpose of reference hashes.`