Copilot commented on code in PR #98:
URL: https://github.com/apache/datasketches-rust/pull/98#discussion_r2826691379
##########
datasketches/src/bloom/builder.rs:
##########
@@ -95,14 +95,14 @@ impl BloomFilterBuilder {
///
/// # Arguments
///
- /// - `num_bits`: Total number of bits in the filter
- /// - `num_hashes`: Number of hash functions to use
+ /// * `num_bits`: Total number of bits in the filter
+ /// * `num_hashes`: Number of hash functions to use
///
/// # Panics
///
/// Panics if any of:
- /// - `num_bits` < [`Self::MIN_NUM_BITS`] or `num_bits` >
[`Self::MAX_NUM_BITS`]
- /// - `num_hashes` < [`Self::MIN_NUM_HASHES`] or `num_hashes` >
[`Self::MIN_NUM_HASHES`]
+ /// * `num_bits` < [`Self::MIN_NUM_BITS`] or `num_bits` >
[`Self::MAX_NUM_BITS`]
+ /// * `num_hashes` < [`Self::MIN_NUM_HASHES`] or `num_hashes` >
[`Self::MIN_NUM_HASHES`]
Review Comment:
The `with_size()` docs list the upper bound check for `num_hashes` as `>
MIN_NUM_HASHES`, but the implementation enforces `num_hashes <=
MAX_NUM_HASHES`. Update the docs to reference `MAX_NUM_HASHES` so the panic
conditions are documented correctly.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
