Skip to content

Commit ae69436

Browse files
authored
Fixing godoc formatting (#52)
1 parent 439d569 commit ae69436

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

proofs/tree.go

+6-7
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Fields can be treated as raw (already hashed values) by setting the option `proo
2424
string value_b = 2 [
2525
(proofs.exclude_from_tree) = true
2626
];
27-
bytes value_c = 3[
27+
bytes value_c = 3 [
2828
(proofs.hashed_field) = true
2929
];
3030
}
@@ -38,7 +38,7 @@ Nested, repeated, and map fields will be flattened following a dotted notation.
3838
repeated Document fieldB = 2;
3939
repeated string fieldC = 3;
4040
map<string, Document> fieldD = 4 [
41-
proofs.key_length = 4
41+
(proofs.key_length) = 4
4242
];
4343
map<uint64, string> fieldE = 5;
4444
}
@@ -141,10 +141,9 @@ The respective JSON for the proof would be:
141141
}
142142
143143
There are a few things to note:
144-
* When calculating the hash of the leaf, the dot notation of the property,
145-
the value and salt should be concatenated to produce the hash.
146-
* The default proof expects values of documents to be salted to prevent rainbow table lookups.
147-
* The value is included in the file as a string value not a native type.
144+
- When calculating the hash of the leaf, the dot notation of the property, the value and salt should be concatenated to produce the hash.
145+
- The default proof expects values of documents to be salted to prevent rainbow table lookups.
146+
- The value is included in the file as a string value not a native type.
148147
149148
Compact Salt Slice
150149
When you do processing for a document, if you want to save the salts, you can provide
@@ -165,7 +164,7 @@ with the SaltsLengthSuffix option.
165164
166165
Custom Document Prefix
167166
168-
Library supports adding a prefix to the document path by setting up TreeOption.ParentPrefix to the desired value.
167+
Library supports adding a prefix to the document path by setting up `TreeOption.ParentPrefix` to the desired value.
169168
170169
171170
*/

0 commit comments

Comments
 (0)