Merge pull request #2 from calebschoepp/patch-1

Improve wording of block comment for hashmap_new
pull/13/head
Josh Baker 4 years ago committed by GitHub
commit 8c85b96e72
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -75,9 +75,9 @@ static uint64_t get_hash(struct hashmap *map, void *key) {
// following `hash` function. These can be any value you wish but it's often // following `hash` function. These can be any value you wish but it's often
// best to use randomly generated values. // best to use randomly generated values.
// Param `hash` is a function that generates a hash value for an item. It's // Param `hash` is a function that generates a hash value for an item. It's
// important that you provice good hash function, otherwise will perform poorly // important that you provide a good hash function, otherwise it will perform
// or be vulnerable to Denial-of-service attacks. This implementation comes // poorly or be vulnerable to Denial-of-service attacks. This implementation
// with two helper functions `hashmap_sip()` and `hashmap_murmur()` // comes with two helper functions `hashmap_sip()` and `hashmap_murmur()`.
// Param `compare` is a function that compares items in the tree. See the // Param `compare` is a function that compares items in the tree. See the
// qsort stdlib function for an example of how this function works. // qsort stdlib function for an example of how this function works.
// The hashmap must be freed with hashmap_free(). // The hashmap must be freed with hashmap_free().

Loading…
Cancel
Save