Skip to content

Commit 237916f

Browse files
committed
Try to make the documentation more beginner-friendly
1 parent a2a903c commit 237916f

File tree

3 files changed

+345
-166
lines changed

3 files changed

+345
-166
lines changed

src/distributions/mod.rs

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,32 +25,32 @@
2525
2626
use Rng;
2727

28-
pub use self::other::Alphanumeric;
28+
#[doc(inline)] pub use self::other::Alphanumeric;
2929
pub use self::uniform::Uniform;
3030
#[deprecated(since="0.5.0", note="use Uniform instead")]
3131
pub use self::uniform::Uniform as Range;
3232
#[cfg(feature="std")]
33-
pub use self::gamma::{Gamma, ChiSquared, FisherF, StudentT};
33+
#[doc(inline)] pub use self::gamma::{Gamma, ChiSquared, FisherF, StudentT};
3434
#[cfg(feature="std")]
35-
pub use self::normal::{Normal, LogNormal, StandardNormal};
35+
#[doc(inline)] pub use self::normal::{Normal, LogNormal, StandardNormal};
3636
#[cfg(feature="std")]
37-
pub use self::exponential::{Exp, Exp1};
37+
#[doc(inline)] pub use self::exponential::{Exp, Exp1};
3838
#[cfg(feature = "std")]
39-
pub use self::poisson::Poisson;
39+
#[doc(inline)] pub use self::poisson::Poisson;
4040
#[cfg(feature = "std")]
41-
pub use self::binomial::Binomial;
41+
#[doc(inline)] pub use self::binomial::Binomial;
4242

4343
pub mod uniform;
4444
#[cfg(feature="std")]
45-
pub mod gamma;
45+
#[doc(hidden)] pub mod gamma;
4646
#[cfg(feature="std")]
47-
pub mod normal;
47+
#[doc(hidden)] pub mod normal;
4848
#[cfg(feature="std")]
49-
pub mod exponential;
49+
#[doc(hidden)] pub mod exponential;
5050
#[cfg(feature = "std")]
51-
pub mod poisson;
51+
#[doc(hidden)] pub mod poisson;
5252
#[cfg(feature = "std")]
53-
pub mod binomial;
53+
#[doc(hidden)] pub mod binomial;
5454

5555
mod float;
5656
mod integer;

0 commit comments

Comments
 (0)