Skip to content

Commit c74a2bf

Browse files
committed
Update docs.
1 parent db2c2e1 commit c74a2bf

File tree

4 files changed

+18
-2
lines changed

4 files changed

+18
-2
lines changed

Diff for: docs/hashing/fnv24.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"name": "fnv24()",
1010
"prefix": "function"
1111
},
12-
"description": "Helper function for generating an FNV-24 hash for a string.",
12+
"description": "Helper function for generating an FNV-24 hash for a string. You probably don't need to use this function - check out FNV32.",
1313
"sourceCode": "src/hashing.ts"
1414
},
1515
"sections": [

Diff for: docs/hashing/fnv32.json

+8
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@
2626
"type": {
2727
"name": "string"
2828
}
29+
},
30+
{
31+
"name": "highBit",
32+
"description": "Whether or not to force the high bit to 1. False by default.",
33+
"optional": true,
34+
"type": {
35+
"name": "boolean"
36+
}
2937
}
3038
],
3139
"returnType": {

Diff for: docs/hashing/fnv56.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"name": "fnv56()",
1010
"prefix": "function"
1111
},
12-
"description": "Helper function for generating an FNV-56 hash for a string.",
12+
"description": "Helper function for generating an FNV-56 hash for a string. You probably don't need to use this function - check out FNV64.",
1313
"sourceCode": "src/hashing.ts"
1414
},
1515
"sections": [

Diff for: docs/hashing/fnv64.json

+8
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@
2626
"type": {
2727
"name": "string"
2828
}
29+
},
30+
{
31+
"name": "highBit",
32+
"description": "Whether or not to force the high bit to 1. False by default.",
33+
"optional": true,
34+
"type": {
35+
"name": "boolean"
36+
}
2937
}
3038
],
3139
"returnType": {

0 commit comments

Comments
 (0)