Skip to content

Commit fcbef8a

Browse files
committed
fix yarn doc warnings
1 parent 5317a5a commit fcbef8a

File tree

7 files changed

+10
-8
lines changed

7 files changed

+10
-8
lines changed

src/cell.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@ export interface ExportedCell {
77
}
88

99
/**
10-
* A cell is an internal datastructure of an {@link InvertibleBloomFilter}.
11-
* It is composed of an idSum (the XOR of all element inserted in that cell), a hashSum (the XOR of all hashed element in that cell) and a counter (the number of elements inserted in that cell).
10+
* @internal
11+
* @private
12+
* @see InvertibleBloomFilter
13+
* A cell is composed of an idSum (the XOR of all element inserted in that cell), a hashSum (the XOR of all hashed element in that cell) and a counter (the number of elements inserted in that cell).
1214
* @author Arnaud Grall
1315
* @author Thomas Minier
1416
*/

src/count-min-sketch.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ export default class CountMinSketch extends BaseFilter implements CountingFilter
122122

123123
/**
124124
* Check if another Count Min Sketch is equal to this one
125-
* @param filter - The filter to compare to this one
125+
* @param other - The filter to compare to this one
126126
* @return True if they are equal, false otherwise
127127
*/
128128
public equals(other: CountMinSketch): boolean {

src/counting-bloom-filter.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ export default class CountingBloomFilter
174174

175175
/**
176176
* Check if another Counting Bloom Filter is equal to this one
177-
* @param filter - The filter to compare to this one
177+
* @param other - The filter to compare to this one
178178
* @return True if they are equal, false otherwise
179179
*/
180180
public equals(other: CountingBloomFilter): boolean {

src/invertible-bloom-filter.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ export default class InvertibleBloomFilter extends BaseFilter implements Writabl
139139

140140
/**
141141
* Substract the filter with another {@link InvertibleBloomFilter}, and returns the resulting filter.
142-
* @param remote - The filter to substract with
142+
* @param iblt - The filter to substract with
143143
* @return A new InvertibleBloomFilter which is the XOR of the local and remote one
144144
*/
145145
public substract(iblt: InvertibleBloomFilter): InvertibleBloomFilter {

src/min-hash.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export interface ExportedMinHash {
3838
* MinHash (or the min-wise independent permutations locality sensitive hashing scheme) is a technique for quickly estimating how similar two sets are.
3939
* It is able to estimate the Jaccard similarity between two large sets of numbers using random hashing.
4040
*
41-
* **WARNING**: Only the MinHash produced by the same {@link MinHashFactory} can be compared between them.
41+
* **WARNING**: Only the MinHash produced by the same @see MinHashFactory can be compared between them.
4242
*
4343
* @see "On the resemblance and containment of documents", by Andrei Z. Broder, in Compression and Complexity of Sequences: Proceedings, Positano, Amalfitan Coast, Salerno, Italy, June 11-13, 1997.
4444
* @author Thomas Minier

src/partitioned-bloom-filter.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ export default class PartitionedBloomFilter
154154

155155
/**
156156
* Check if another Partitioned Bloom Filter is equal to this one
157-
* @param filter - The filter to compare to this one
157+
* @param other - The filter to compare to this one
158158
* @return True if they are equal, false otherwise
159159
*/
160160
public equals(other: PartitionedBloomFilter): boolean {

src/utils.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ export function xorUint8Array(a: Uint8Array, b: Uint8Array): Uint8Array {
8585
* @author Arnaud Grall
8686
*/
8787
export function getDefaultSeed(): SeedType {
88-
return BigInt(0x1234567890)
88+
return BigInt('0x1234567890')
8989
}
9090

9191
/**

0 commit comments

Comments
 (0)