Clarify what reference hashes are used for.
This commit is contained in:
parent
47c6de7a1b
commit
d7d098ba35
@ -125,7 +125,7 @@ pub fn content_hash(value: &Value) -> Result<String, Error> {
|
|||||||
/// Creates a *reference hash* for the JSON representation of an event.
|
/// Creates a *reference hash* for the JSON representation of an event.
|
||||||
///
|
///
|
||||||
/// The reference hash of an event covers the essential fields of an event, including content
|
/// The reference hash of an event covers the essential fields of an event, including content
|
||||||
/// hashes. It is used during federation and is described in the Matrix server-server
|
/// hashes. It is used to generate event identifiers and is described in the Matrix server-server
|
||||||
/// specification.
|
/// specification.
|
||||||
pub fn reference_hash(value: &Value) -> Result<String, Error> {
|
pub fn reference_hash(value: &Value) -> Result<String, Error> {
|
||||||
let redacted_value = redact(value)?;
|
let redacted_value = redact(value)?;
|
||||||
|
Loading…
x
Reference in New Issue
Block a user