Skip to content

Commit

Permalink
remove the known issue from doc
Browse files Browse the repository at this point in the history
  • Loading branch information
benjamin-lieser committed Sep 13, 2024
1 parent a007613 commit b0021aa
Showing 1 changed file with 0 additions and 11 deletions.
11 changes: 0 additions & 11 deletions rand_distr/src/binomial.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@ use rand::Rng;
///
/// `f(k) = n!/(k! (n-k)!) p^k (1-p)^(n-k)` for `k >= 0`.
///
/// # Known issues
///
/// See documentation of [`Binomial::new`].
///
/// # Plot
///
/// The following plot of the binomial distribution illustrates the
Expand Down Expand Up @@ -106,13 +102,6 @@ impl std::error::Error for Error {}
impl Binomial {
/// Construct a new `Binomial` with the given shape parameters `n` (number
/// of trials) and `p` (probability of success).
///
/// # Known issues
///
/// Although this method should return an [`Error`] on invalid parameters,
/// some (extreme) parameter combinations are known to return a [`Binomial`]
/// object which panics when [sampled](Distribution::sample).
/// See [#1378](https://github.com/rust-random/rand/issues/1378).
pub fn new(n: u64, p: f64) -> Result<Binomial, Error> {
if !(p >= 0.0) {
return Err(Error::ProbabilityTooSmall);
Expand Down

0 comments on commit b0021aa

Please sign in to comment.