From 3fa021e856684171c3d9a82efb5f73acd36b00cc Mon Sep 17 00:00:00 2001
From: PauloCampana <paulo.campana@academico.ufpb.br>
Date: Sat, 6 Jul 2024 00:58:42 -0300
Subject: [PATCH] update top level doc and add it to header file

---
 docs/sources.tar       | Bin 12754432 -> 12754944 bytes
 src/root.zig           |   4 ++--
 test_compile_error.zig |  46 -----------------------------------------
 3 files changed, 2 insertions(+), 48 deletions(-)
 delete mode 100644 test_compile_error.zig

diff --git a/docs/sources.tar b/docs/sources.tar
index 3eb622ac563b6e6d412010624f6beb150e6ad853..7cfd2fb4662e6f817aa6acf0c047f45e7ce22473 100644
GIT binary patch
delta 1528
zcmb7ETTok76y<V5plP9Cco>T9g({GOkN`=vg}!Ljib|{X(fX)qxIAh|ViKsORcNJ4
zq}4*B93=%>QLD=rG|KgXTJr0RGdhksj-Sq`Gko~rIOB{T-T*QT@}cMJoORY-Yd`Ki
zJ=6Who~!-FfnJNlRh_hS*=#mPjop=G8_a5oNs=+S*dH`iRu(EgwZ$E7>r|Cct2>}p
zhCFVsss!9Yce@%^gQ3_~Ilg94$-0u6`@J0S2O^WR1u@4j#|()>Y;txqHBH~t`#XH$
z$Yg^h7Wm!l%Xc}d>`Tp)Y&N^yURAx|9?O=roF=KpAPT;d(j#578A9o;OHKE9yGmPB
zpBi+B{XucEIN2=9+N6y_TP;~dv{mZ=hhMX5kt+61H*63S`}d`Z-+m}JL@st46G7*U
z%|1mZ={e<gTa{*KjdI+i=&REmRJ>iAl@1-LQ?@VaBrGf1eBo04!fM^J$n_*D)0y6`
zdF*Iwo8F&NZ<kV6r|8rL*@ScgTS+m0iDZH|FIkq*jLg^yQ|8W*!avMn{SnEeebpva
zrbUzyAA%Bs$x}hOH^btzxt2B5=5#sd8>&gM;zCI)IwjZ3;_KNmvk3fIl%kzDEq|Gu
zk}y=XJ$-UtvT1Irp$f0+6FVZZJKN`PQY$?E_JCI(b)!!$)$0~L=1aL^A|hL~gJ)!e
z^nZhXJ}VzE{`VkFcdA{US)-^OlGmD7NbmB_AvtZCdSkiQ-*U+7_voLo-*;lkKvob~
zsPFu!oFm3Z<q|QbNcm!SV@{^%7jmBXYgEoiV0mKZ*TFn75Unt1C1dgzt3VkvfGMC6
zOa;?G9W;Tf!8Kqym;tT@Gr=tI8qf@8gE?R>m<L`9TEKj89asQf2d)P<fC^X$7J(bV
z>%kkqVz2}(1+CyFuna5*Zv-pAO3(({!78vCtN|UM6Lf($fj5Jj!7X4dSO;zew}IQi
z9pFx|9^3`)25$jx1#biQfVYDU;2q$d;9X!NxEI_9-VNRZ?g#G$?*s1#9{>-42f+uy
zhroxyN5Dhiqo5l+40^yOPz9U87O)j;1CM}@fnKm3^nrdb06q=|!4Mb*JHSrxDEI_;
z4D14rgD1cz!Kc7(um?N|o&ui+d%@Enz-Pcd@L8}QJOiEup97x<&w&HrAb1{(fG>bA
zf<vGHUjknShruX#0UQBG!7=b6cnN$390y+oUjttUFN1G@Z-NBh0^bJT0pA7R11G>q
z@Cq0M-v>Vcr$7z-5c~-I82kjB20sNq13w3^PI0F9CyV{x@3GV2bj-boi63~Kq!kRr
zJ4`9N)WaPuVq`epB!`0?A|)DE<~G)7d|Z4p9M2LzM&k{JX16z_ZMqQuRvJ`N{|1{W
BUUdKf

delta 1130
zcmZvbTTqk*7>4=zVL<|v5NreGN6NG~>;emwl_j0bGQ|#d)D`|<b=jq5!2?mK^iY%`
zko;6aVWk~jE!^bqpheq7cU?AKblFrF&UDjEw=GgL&g6IXzTf*D=9~H6{<$Gf|G6R0
zkpXXmzdr5q@cDd!dVgJ-Z=|3#VHlqD#$cp1r>3UdYO!PSU?^gB24levJ8s9itUaN4
zyVVm6ciYx}I~KK~F)L!X1>>O}yE;*2CUeg$DZXIt48_N0E|w+&f9%VcCyAMhQ(4(5
z&=l>Cq@<1BMCV_H5$DkQ-oh-u-(T18@Akw}!!2qx>NCb_e)l-Pgp3O3bi0xGj}1Gg
z%8Wc`aoEUlTXq{Y*~AUv>9cWjAm8h6^k05fTI#Nb#z5nx$*ysBRk`7=959<q=fH-H
zWp3Y~`BS>PWyl;%cSc9e%}&{{nd$s_)XZ~sO`G}ibot4l!=`a1)lI1}&y|$<KCioO
z+^o1Xw%Iv9VdlBNO_+aYEtKz_HjA8*X|uxcIdjuyv7-}a$%=5aZBsPX5e!#a)xDOl
z(n=+^ceMn=w$-<0t-JcTd0~;e<6vgKflQQvGLZ*mp=`7W<)EujF3LmsXfaxX3eeT4
z5G_STs2D9n*B~#t7L}k<v>dHKWynJ1XeFvZ*P-jtDs%%{jn<$W(M_llRiSEBgM7%3
zYEd1kM*-A;8qv+@7IZ6Gi*7@=qdU+#bSJtCtw&AhZgda27u|>MM;p)sXd`+MJ%l!)
zhtX!V1vR6s=n?cNdJH{|wxK7`ljte*G<pU-i?*X3D2R5V7SxJt^c-qK?I?tHq1`Bq
zI#2{fQ73vH#ZVWDqi)oL_Mp9JAKH(4(F>>#y@*~y{pbKXhz_9v^fCesqF2zXXb8QA
zUPp(~8)z6EK_h4sjiEQuQ8bPmG=bhiZ=-k6F*J#$(7Wh8G>wj<_t6LFLv#Y2L?5A#
z(I@CrBy<X$MxUY2(F{6+66gzb7R@3TeTlw8U!!l(IdmR<i@rm1v-*DES8uJa_J1x3
z1Qz@^?~)S3EgemE=j1lqVLRAmZ%sXA*cm^TY;}H^OcppflgYvbR5h6#H{-Ex=f}z9
Nwt3)IOeKFd{sGQP=6wJF

diff --git a/src/root.zig b/src/root.zig
index 30cb0f2..3c5a33d 100644
--- 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
deleted file mode 100644
index de82ba8..0000000
--- a/test_compile_error.zig
+++ /dev/null
@@ -1,46 +0,0 @@
-const std = @import("std");
-
-test {
-    // _ = &std.ArrayHashMap(void, void, void, true).move;
-    // _ = &std.Build.Cache.Path.makeOpenPath;
-    // _ = &std.coff.SectionHeader.setAlignment;
-    // _ = &std.crypto.stream.chacha.ChaCha8With64BitNonce.stream;
-    // _ = &std.crypto.pwhash.bcrypt.pbkdf;
-    // _ = &std.os.windows.GetFileAttributes;
-    // _ = &std.os.windows.MoveFileEx;
-    // _ = &std.valgrind.innerThreads;
-    // _ = &std.valgrind.monitorCommand;
-    // _ = &std.valgrind.memcheck.doAddedLeakCheck;
-    // _ = &std.valgrind.memcheck.doChangedLeakCheck;
-    // _ = &std.valgrind.memcheck.doLeakCheck;
-    // _ = &std.valgrind.memcheck.doQuickLeakCheck;
-    // _ = &std.valgrind.memcheck.getVbits;
-    // _ = &std.valgrind.memcheck.setVbits;
-
-    // _ = &std.fs.createFileAbsoluteW;
-    // _ = &std.fs.deleteDirAbsoluteW;
-    // _ = &std.fs.deleteFileAbsoluteW;
-    // _ = &std.fs.makeDirAbsoluteW;
-    // _ = &std.fs.readlinkAbsoluteW;
-    // _ = &std.fs.renameW;
-    // _ = &std.fs.symLinkAbsoluteW;
-    // _ = &std.fs.Dir.makeDirW;
-    // _ = &std.fs.Dir.renameW;
-
-    // _ = &std.crypto.Certificate.Parsed.pubKeySigAlgo;
-    // _ = &std.crypto.onetimeauth.Poly1305.pad;
-    // _ = &std.crypto.ecc.P256.subMixed;
-    // _ = &std.crypto.ecc.P384.subMixed;
-    // _ = &std.crypto.ecc.Secp256k1.subMixed;
-
-    // _ = &std.Build.Step.Compile.dependsOnSystemLibrary;
-    // _ = &std.Build.Step.TranslateC.defineCMacro;
-    // _ = &std.DynLib.openZ;
-    // _ = &std.heap.alignPageAllocLen;
-    // _ = &std.process.changeCurDirC;
-
-    // _ = &std.fmt.Parser.peek;
-    // _ = &std.fmt.Parser.until;
-
-    _ = &std.debug.UnwindError;
-}