prashnts / pybloomfiltermmap3

Fast Python Bloom Filter using Mmap
https://github.com/prashnts/pybloomfiltermmap3
MIT License
130 stars 24 forks source link

Doc clarification request: error rate #36

Closed leopd closed 4 years ago

leopd commented 4 years ago

I find the docs unclear about what units error_rate should be (in the BloomFilter constructor). I wasn't sure if maybe it was expecting a percent (because sometimes people do that), until I dug into the code and found an assertion that it's 0 < error_rate < 1. Saying it's a number from 0-1 in the docs is enough to clarify this.