update top level doc and add it to header file

PauloCampana · Jul 6, 2024 · 3fa021e · 3fa021e
1 parent 51bde1f
commit 3fa021e
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 48 deletions.
diff --git a/docs/sources.tar b/docs/sources.tar
diff --git a/src/root.zig b/src/root.zig
@@ -2,8 +2,8 @@
 //! functions for probability distributions.
 //!
 //! Asserts invalid distribution parameters on Debug and ReleaseSafe modes
-//! such as ±NaN, ±Inf, probabilities outside of the [0,1] interval and
-//! certain parameters with value zero or negative.
+//! such as ±NaN, ±Inf, probabilities outside of the [0,1] interval or
+//! negative shape/scale parameters
 //!
 //! Random variable generation has 2 flavours: `random` and `fill`,
 //!   * `random` returns a single random variable

diff --git a/test_compile_error.zig b/test_compile_error.zig