Skip to content

Commit

Permalink
Merge pull request #178 from mbrubeck/doc
Browse files Browse the repository at this point in the history
Fix formatting warnings with commonmark enabled
  • Loading branch information
alexcrichton authored Oct 17, 2017
2 parents cbfb7cf + 9d44ab6 commit 6fd1009
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 6 deletions.
4 changes: 2 additions & 2 deletions src/distributions/gamma.rs
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,8 @@ impl IndependentSample<f64> for GammaLargeShape {
///
/// For `k > 0` integral, this distribution is the sum of the squares
/// of `k` independent standard normal random variables. For other
/// `k`, this uses the equivalent characterisation `χ²(k) = Gamma(k/2,
/// 2)`.
/// `k`, this uses the equivalent characterisation
/// `χ²(k) = Gamma(k/2, 2)`.
///
/// # Example
///
Expand Down
1 change: 1 addition & 0 deletions src/distributions/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ impl<'a, T: Clone> WeightedChoice<'a, T> {
/// Create a new `WeightedChoice`.
///
/// Panics if:
///
/// - `v` is empty
/// - the total weight is 0
/// - the total weight is larger than a `u32` can contain.
Expand Down
5 changes: 3 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -354,8 +354,9 @@ pub trait Rng {
/// See:
/// A PRNG specialized in double precision floating point numbers using
/// an affine transition
/// http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/ARTICLES/dSFMT.pdf
/// http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/SFMT/dSFMT-slide-e.pdf
///
/// * <http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/ARTICLES/dSFMT.pdf>
/// * <http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/SFMT/dSFMT-slide-e.pdf>
///
/// By default this is implemented in terms of `next_u32`, but a
/// random number generator which can generate numbers satisfying
Expand Down
4 changes: 2 additions & 2 deletions src/os.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ use Rng;
/// Max OS X, and modern Linux) this may block very early in the init
/// process, if the CSPRNG has not been seeded yet.[1]
///
/// [1] See https://www.python.org/dev/peps/pep-0524/ for a more in-depth
/// discussion.
/// [1] See <https://www.python.org/dev/peps/pep-0524/> for a more
/// in-depth discussion.
pub struct OsRng(imp::OsRng);

impl OsRng {
Expand Down

0 comments on commit 6fd1009

Please sign in to comment.