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

Clarify the purpose of reference hashes.
5 years ago · 7b0f5ea77b
parent 52643a92c6 a3d2d14dae
commit 7b0f5ea77b
2 changed files with 4 additions and 1 deletions
--- a/changelogs/server_server/newsfragments/2159.clarification
+++ b/changelogs/server_server/newsfragments/2159.clarification
@ -0,0 +1 @@
+Clarify the purpose of reference hashes.
--- 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.