From bb127a5a225360afe1f60633667a399202ce5023 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Luis=20Panadero=20Guarde=C3=B1o?= Date: Sat, 27 Mar 2021 13:04:17 +0100 Subject: [PATCH] Documentation updated --- CHANGELOG.md | 6 ++ README.md | 11 ++- docs/assets/img/logo-dub.png | Bin 0 -> 14403 bytes docs/changelog.md | 6 ++ docs/index.md | 11 ++- docs/pijamas.html | 139 ++++++++++++++++++++++++++++++++++- source/pijamas.d | 17 ++++- 7 files changed, 178 insertions(+), 12 deletions(-) create mode 100644 docs/assets/img/logo-dub.png diff --git a/CHANGELOG.md b/CHANGELOG.md index 8485130..f796be7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +# v0.3.4 + +* Update to DLang frontend 2.91 +* Using std.math.isClose instead of .approxEquals +* Added .close as alias of .approxEquals + # v0.3.3 * .throw must be @trusted, to allow to catch Errors diff --git a/README.md b/README.md index ef0debe..dee1d57 100644 --- a/README.md +++ b/README.md @@ -58,14 +58,17 @@ assertion. 255.should.equal(10); // Throws an Exception "expected 255 to equal 10" ``` -#### `T approxEqual(U)(U other, U maxRelDiff = 1e-2, U maxAbsDiff = 1e-05, string file = __FILE__, size_t line = __LINE__);` +#### `T approxEqual(U)(U other, U maxRelDiff = CommonDefaultFor!(T,U), U maxAbsDiff = 0.0, string file = __FILE__, size_t line = __LINE__);` -Asserts for aproximated equality of float types. Returns the value wrapped around the -assertion. +Asserts for approximated equality of float types. Returns the value wrapped around the +assertion. See Phobos std.math.isClose(). ```d (1.0f).should.be.approxEqual(1.00000001); -(1.0f).should.not.be.approxEqual(1.001); +(1.0f).should.not.be.approxEqual(1.01); ``` +#### `T close(U)(U other, U maxRelDiff = CommonDefaultFor!(T,U), U maxAbsDiff = 0.0, string file = __FILE__, size_t line = __LINE__);` + +Alias of approxEqual #### `T exist(string file = __FILE__, size_t line = __LINE__);` diff --git a/docs/assets/img/logo-dub.png b/docs/assets/img/logo-dub.png new file mode 100644 index 0000000000000000000000000000000000000000..4b954616327e2fa160e8774104d67941ef2af768 GIT binary patch literal 14403 zcmeHtby!sG*8b2TN=ggEkOD&vF-SKGlF~g4J><~cNJ)oCBOxy(ASI_!%2#6BW z68a75dDU}#&-vc#_xt`k%*8c(KhIkCTI*i1_w1RwYPS_G<5S}U0D#L%in1C206OXr z9e|6CdfWFLI{^SlK6q>CA~noBfKD!smNxcqAkxbT4upH!SONf^({uNy+*TSA!xzlD z(gVRnfl%GSM!J|!dsvFEA8oYG-BB$_PQJ-PifR6dLe1gJc0k-IeJj&Vq+V^RcGMb2 z{jB-gy^Wm8HR!Q#K!9)8(YioI(CY-_zc2QAC4$$5QX7^&sFoiCp1^5spZ6x-;z?o!?vZoqp#2we*E?cmm) z)kR(-YX+B1QWxF42+~8pY%{(tS`V#k*aO}#@bSLXf8%t< zm*!MCvvpuuV(5i65EImao^$+eN&LpKBb^DhNcT-4Op~_GC@(n<$s)6inuP~)($BnL z>_V+aORc3eUsTLVsgh|{U!gbC4-&~do0z^SG z3bSXdx(qNbaQQE_^1fzls>dAuX{ajeoHdFc4Vw> zTK|1kw0roLZo{8^?zuWswwyNN%Xbq`>XrcR(# zem-(n;Ib`MZf?QbzKM9(+CIGj-)IQd;vi>NVofkShG6wt{(~K64-@{QG%wf0FY5De zD*4tp-2y}8r>y}PU#q5fP++i$D z&t9V2k!=9g8W^_q9Bb39&lv)@?iGF*4KinbJlFl2QKc+Yg!|ddyU^0dteOX~=j8sR z%QuNt88&Xi!~yPNt{Oc)15}V$8Mk8f=TptuauK?Zd%V@7Z!NfGHTtYuRV0Yo5Z-2v zn{r8>vS|is-7LZi>_BsJv3D`~&f>WT#dX3zhJSc!rlr zqZ>QU)hdyA5>6j!9nELwUS=e>XS?a!PS5rv(E)hE@-|Oi)W@XX2gG!W_C1YS(Jcli z#DVgno49R69yNoYtBAyU{iF3U>kZN{eoJwqL*c-c>jh(y?LJP8eY4g;?ingzWUN6(QuuJc`sj|9t zHnxLZn)r}D#|S4!NGiv{X!PoE&vu`_dxU;uaM^Rs8^HIpoJ#9(ku%DuqDNZy9_Xcw z7w~)BmKqQru>N-o3Qge-uxM~DVDA`;e6>8=nriP=H8Jg;R?hv3?#BM ziCe#$_d_FubFf`$ah^TNPSuxld|_stbvxQCTR7fP{jSWF0)`SHN$K`e-Ro*2KxNkB z@oEMEKwuHgqV|*~!^(IWqqoAypVy0NUF@)O)u;(|~qZGs=kypjJQALqcXvcoVT)xJ}_vz{DOKLTl`S;iY z=--lzK*X@}gM^*bBRDNDJ7*cB)n8}B6A2oKJUn5$zx+Y+tR_Sj)Nz~8qCjZ6O(x(- zh?SCn$XOepM)k;Bz(shh4SWQ`c&brv{TXTDN9!=-*`K?S*1 zobn;BFV66p2HIV(-LeXTgAwrEXjRq~dl&GoAUJ59c(j=KUWhN+bjN`hBH#3(x{RrEiIoQCVh~kBmtw7uIc+k?e@AI~!?!WC>UPvV&T~=~ z3@G`d&|R4hbuZ3CG%e79PU!p3#QeR5)3&5gK3trx#K6zCtFIHf%})e)8K#C!UVXHd zojx%{pH_U3#~-9LMxX|xp2$(pOe{UAl|$~!7K$%^L>{H*Mn*=;D~W&5-mU@O8tUhl zc(A5kH5ta8w&Z&>g(I?Ij{&`$)%*IB?@L45lu=e?9KXsGUFP`*aVkT+?^HRhJkp6v z(_Q46LsVj?mIC;u_;m|U_e|A?I#c}3^+T+lOJ=U_>KQ>-`DlP*@n#Z!7&e|(KNFF)wyiC%jx!RfE~v?T zD#H|Npi*NyTVy{1CnDTHLjYNEuk53%{(+ty6f=yxk|%+iB}8hEj-mM&5mGTUKFC62 z14!;&MVJT6XMf~^(01|(mrb!v4BsLiE34I028gHF35VF{hM1fi_+|u5h;PyFQ#~u! zcmyryQcMt|8|hSsm}2fT4m!CgN$fT!&!?ePDhL>8R_r7lRkuOEz zqlB&MSZMN+pvR>6je{Eg>pJ^q*ovre>`WsyL5V;lYdd^1IMfG zvYBZN$L99bZnqD-C4Dm8Vm&&kJJ2-lUd6PmuE)y`%ECBqqvl!i1znLO+rUk%<4ZG3 zwnArRiouI`$FH)!9Hn9ti_g*1sCZ63)A}Tqu%jYiUV%qG7`!$P-D+>BFk77_U2e8; zJQcvkE6pHp&TKuzP7mhM(#2COzqg|w)ww)f@YbaM@(Q8I9gp~md#ZlatOh|7E5ipo z+-U?46&tKn=CEmS^@`@I^!^xolw7v8qHE%Rd7J0C@FFLGW=bhcmLH@T@qEPr>WkYf zIsfIsc5%Slz=eI;OIzBTLa(F!h4Mivl5!TQmuo57tQczPUZOAB%cTq5%GOGzF%_)g zkL67b!e6+Yh%Id;e~4wU3>u8(TlL%hLuyBIoOxct&t(mM*jO-0tR`NNkg3^2Q zwc|jy8RaTQE)Ro;2X}^|=}cw_Rt4Q4>3H6PrL%LvB1sB0PFG2(>Ylq@yOpZYm$+lc z6uZtyRh_1+cPmCEzP-c*DYR(CtUSxFy|7{~rt0ChV7Rqe5qO5*^H=nz{l4 zD(K%*8DWWcmBsWc7~>caZNDQ(dZ+IuullBGw|a3c!xp;QW5n5(Pw-2~&fGd2G8h*qVWAtT)6P%K zXU&A2Q=YlFEAJ|@*W7VTLQ`^i%66t@%DVx;NVQtz6?r*v=!qChnb6~HPZ0WR?Aplt z`_E!lNpcf%(eX;=#01TQT$m+GZt5m=-1QZFA0|cJuxz;nz0K_9S$$LgLj~JP7@D*; z$kHl^K?;AYMW7u63^xC8g>KAZygE+BGDE(U(pb(yipqmEUxN{wzeA9O(Y*uLXp@EP zPQ+r7tDxZ!C{Ed4+|xPVq{PUDp7q*%$p<>}Y>)m>B@VkTO1pv8dIsy@{L*;BKHpAC zgWPg>b@nC7K(X8! zgpKK2$OAF=$*%F`xruvE5ItZ&p%;hsl4y^s-n|Z&c293v{gwxqqSCOf34Kv5( zXmb29nQI9qJkNB`vsF2I@7VJ_XQrIiP%fQx2W|r}cQ`c5KN{oSF&v25Po!cKd9UOb zQpp|wt^Shi8FTI^79d0N zp}gKXjJ35NSo)QzmZ?o18h+$!l{lRWcr!kE4`UNTB-y1PIp}^xQn*C%de^Y@-0Ns^ zt;o5fL=7iXvW>j)f)ES}bz;!~_7-4*D^Ug#Dl3=8P5DVzOYkrsGgWn4Mp>X^nc|GF ziLI=xp&=AO((I?^x^La9e2t*=BShH76I}~>Gzq?o@raaBmPt`15GZj^4Iih&pIVL) zwusY=P|~>r4a4b}P z5L95pb-cSuAsZzD#MKp8p?%XLSp*S@>5qm9rP!=Id2&l&(hBdk3W1KY!AUswV?Udj z3?qT#V7jUs;(C5KiixzR3QVUaq-A0An*pG}>s{y?z?d?hgmINeY@@M@%1?PxYiX8` zDPLfPr@wD$?sux2b|8?p90DbkaW^Zl<}W_`*bbWBiHW_&gJG6AU^m?w+WFWZNawIn zq>MXMFw^v1#C{Dh2(I(YUj`;N>We8KH~$6S{P?4TOz9-~+8XBKXUvc@2^!qM+=Qi? zFBlah1L)27u^a&a!YUiob1z*LWf7Pog3HXp(Hzd@iEu(a7Xtu9B|M$XV0LgM&>U`M z;~)mwZf*ksZ7jqrY^R#j21Bv4UMO`c`MKomP zzeAwT#6Z?aq>~6Yw}*!Zmj^$Wql*o+z7-k8m>q=_aF9ttKq7Jdi=<( z0e5wDbAiF-+~E#L#-EKk*}J*^Y}3sZezEk`Z+i<%Zj@7BE&r^eproSqr_Ke9RyGKy zuNoK9KTBG`{*-fabFu#_V*%ra+rtqkM_f_JyuZjJZ7hEz=$CjdcK*c?l(|3gf06zN zUtfLs%BzU1Bh2l>sFJK0=)zwS3rCoZg~-=KD6b`45W;5(hFkK(!4OLeVK5ZRCk*Bn zwiFbGnpp_IEzEv`QgU!bnmNGW7f>j0E*lgMT!>EqZpjM+o5P{PUTdpTM9x2zd~K)K}1STNeslt#q(oD&E5=Y>F9zG11Z}$xOx8A(6T|mHIZf)r11&} zLj@oL5J5p6VIe3~;D?Yl+{G1DO^WZU6e?g585g)2($PiB(a~NE zbP*8n!tU3;1B!m{C=q2x*jL4`!f=a=ru^QP(q>lNUr$B3|DEu^AZc1VdN};=aDIsX zi6Z5K^l)^sQ*}`_w}r!y{~qUe!ha%Zpa!BV(#1>ZKLqtpa-!dAS`nq|=;HO0eNDLY zx3h0k%iiWIRY2g^Ng-ke`$oU3nLFI#YYI?2e%pdsn>kp)Q6u?#KmKFg<~OwtH5Y^m zo5Rh(W)L_O41rie!BBonelRZ|1R@0GGqW%ghW?7~>S&4dFmr)RS)nQgm1k7{ea$nF z?Q4l%|5e(<8jh+Y4jw)c9v;xQ^a4e>FQ)E4!V|riODZZNKNBE&F}FmNF6vX$&B@8$ z2JZ4JG5;u(zmWS$|9esXC-tAjzG=%iI(eZw+Zw6r;qY(G|3>f|g0c+^?%?Y9?_B>` zE5e~tVte*a6?f9d*L4E!zO z|5n$3>H1p?{4L@CR@eVGy6}H|42L_QZuC4*AF^#8843UZ_`EhUGHOaPGC;L&zgYnQ z6z^uGdT41*kw*-+2(_ps5=A8s*;#9#D_(9qz%U_DdT z#S0|J(xztxwlc**BiI38*aH@wYHFm(kLA%b(0wOk>@!G@DO#GY06(3wk4nUJ z0KViTH|l|S0cz3`TYjnQhwBjh6oi)6L zmScCFdwu&P=SqN#iSM9B>)iHRGta#w;Y1{_jIoe|rFW5RXV1VJr%wc{IT6S7IG^3< z$cfLGS|hoW7~1x`^g;pSQ-AbuMtauiVDM)@od)I4J>*OQaWDm0z6KKYfe-i3^wA+e zfSe@8h9u2825CFylXl_;0O2AAx)fU^rn4#UVlY`enk1l(hugEteP) zBIrbk41z5}gmJindQCBB(KL9jWCvc~!S9nK3JvQax~dU@1j_W#J`U53r&+3 zO~z%Gkyb>%D)~NFqlETR_(q=Py1_adlDY|SS*AW$-J0a&sy7ZJ4_;A+eigAjR*k8u zFm7BZMaRn>K4E&U;QICyCk$Vrtx(nHX^X_V_!2?I#DPS_BKgrg#N^N9r4u}v@Q4}8 z;zYwPl#?&LqQ4sUCOj*%hek68mbza z(Ku)r)r%OjqH5hgM8;{~M_ul6sWP|ceS+^p4~t3q3G>Mj?O!a z`cAA)I!>ewR8L9fiMC@1yY_Z^Kf;gYeF^<>CE{`z*hpjWDnb>d+0DRti9_cfMBeUn$`5P^*Hsdg6;-8WZe>m0eVAy2M0?mP1fJraqEeKsi^_1tO z9awT07FgTVbJ=y-G1+#=v^mDuknD!)o<)&55UqVJ!#~n1b@M!BofSWpk{G{Kyj$L> zuK!T00IBsZe597|&Xhb<3o7GP;}X4#^;Ut5vn%qA%#wN(+bNqB8%!(okt$rXam;N@ zenW3V__7Rt5!R4~&BIzp>yX;(SEHh`Zr0w+z8U+<`Res+c{IZq>+kmYPRvf+PHx-* z-%-8Oy20{V@HNMy%GawUUL_x2-yEBMEk8D2%0K2eHab>c>QTBdDru8$6Kc0&`(aqP z>?86DBCeNq>p>zkVr_OjRG=Ti2+^_L8l@e2Fg`NAJNjzm(TGUFfmUY4W?t5#7Mat~ z!@?_fx>Xc%Yh>062Vmj&&yx}cN-Xwyi;x0t=WfhR2TdVO{N69T)xE>KH@%Pc@lH6; zna;1Bw47*Si(oTgV_}zL*I)h^&iS0|xl#Cecx7x%ta*$er5lwPpEmy$o&g~TfmSgP-lhGteS?pB1Ao9nzVjv9?5?R4vgEf*|jzA2_S;hb%B z673Mr6J9z2Ez5aDb8(LAK4?8YCh1~+z^p(re3$nw`0h3|?*aC}{z%}%x?9B!_FG(A zq}e!*IF57-C6$?+!|P%! zEn*mH3F*#Sio`{Dr+jt%dwdZ!eKk=vg}o2bHVp-t@ks>WGE>oyo4X)WgJXf6vX71V z?k}fmChf5Zi5w|ryJYh?nl?`Ds`Rq%`t7wD2kCbh4IAVdR6Q|8K3scsa%bq#!!mE3 z_my1wVy!P6`-AF2>ul@-*lM{rxqTbCER9qXw1@BKS0DJlH;BF(CD$b+*kE5W6FJQ` zDcoSQRrE-O{+1^*#jWyN95)vnR~=f9Q~GsMO#G%3YvEOWdG>?aecDUo?`LM~ud(TH z4RX`Z&^>N(#epfjj7z(b_Tj0TnT~pWbk(iLxAdtDr;Olgb#)tlZZ{7UV|7$~$}KmG zrYD-cnkzqioE+6IzN4dm)607aa! zh0%wm6{k|ycK_UEoKt!c>}%LJB4{I;xNjJ3QDqDHzKJ?b8P#d2%x)%k+8pUQOIUiZ zKH)g8*uc>8viZ}x_DT6#y{p6Etez`{U;RqHrziOt;{qjX`B2qvIXBpPVS%UP*qwQr#)2u|WM z$Lp=i_lgESIIL!QWxt=v`p`NTdXL-J>M`mYS~NiHZZ;SIKm!190RTyqOQ;`j69E8$ zs3S}O0El|~_gjBc{D+Z$L07VwK`*Hkqle2hZuR4ItOlc)l0@16XA6N#PV@l9*(%F( zG}hlZnu{NUhVJ+_p=}Xm;a?)r3gVSiG_*GyOhW&M_Al`%8j(xy^l+CnP~3VKv)9tr zl|$x)a^Q#CKM>V|PXUrxg^;zj#2c!66Yg8PYuFEd=dZ`;6RdWiU+XYk;9rFFE613D z|1lvkYBS`L(=VDn+4Y`p7*YJz#rZH^Ny-F@TYAe!ixUPP#U>j$j`RP@gWnN-;gwc$ zH=4|w)Ki9;QPu)hE>ILq$>eklP-6c8#~B{iI(MD`d2FE(fDFSTrq9+(ikJ)iZ`FF)67 z{#^g8a<0{{nVV7=W%8e$mBgUJ2o>^`_`>Fa`1In_y4^imXky>mQ{+1hjU47f|L#M& zUZc~kGG`Op@0|arhwo7o79uW{lue2T^nDn^X|%J_@6NAm@vWS6J3arbcDUI6@Uo28 zrjSAQ)h5gOnb?XP5jS=Zu;6?8nVI~B5ba(u%-<&SQ9C6tmW+nR;Bwk_SNFjcN3ftf zMMVzxS+;qBKS#^LtlvFVGY+9>E0Rm|Ire)&0LdPqg{(J_wFl%lHb6$2vt{I zxwyDiD>mm_W+>>sPl{g(5NP%SP+EST)!b-z>5>OcH4ZB7duK*AvQ-P)3fe+UH8>xu z2ej=1Sf7Y&QQ-Yj`QQ7;G=&O-Nw3n_a`=Gzh`f30fM$ZaIv{D(mE(+Jko~})(6K*2 z;vRi>E6(XH-)_(sZ(E$U(BG2EXi7jdPeeo0?0zs`wv0ONN)NCE(WtIMcgwl+-KpLZ&MW(??^Wi%BKjT7DTn6YZb`8Chqi_?lR&2VKQONO3%=c_LZCFbOfJImE(eV8_{q5ylRQ^v*R5H;ib02%MaZI6_yOw(5Pl^CvcuB4HH<`{%X#<>S$u9JM&CR}hD9F@JIW!sm;@QThZNXnC^q z!UcK0-VvvQ{)^DBGwNR&|63%1D5PJK`W^Z&#DBWF{W1anO8hzMS~8@pKGEn{+N+$U(*%lj!2Va6V3?Jw3(y2@1Xjf4a@boTGV{Z|`vvdLSw?#g8Pb^NxI z|Gx9>0d)v8f`PsYG1RzooU4`M5O%h%QTcT=e?Sz*K7iLB<&>5#60>VfxitH#rk3Z>V|+aVNwj;xTO!@VW3;64$3M(N$$36g|un# F{{Su%Y*qjO literal 0 HcmV?d00001 diff --git a/docs/changelog.md b/docs/changelog.md index c9590c5..f9ce724 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -2,6 +2,12 @@ layout: default title: Changelog --- +# v0.3.4 + +* Update to DLang frontend 2.91 +* Using std.math.isClose instead of .approxEquals +* Added .close as alias of .approxEquals + # v0.3.3 * .throw must be @trusted, to allow to catch Errors diff --git a/docs/index.md b/docs/index.md index ed85b14..354eede 100644 --- a/docs/index.md +++ b/docs/index.md @@ -62,14 +62,17 @@ assertion. 255.should.equal(10); // Throws an Exception "expected 255 to equal 10" ``` -#### `T approxEqual(U)(U other, U maxRelDiff = 1e-2, U maxAbsDiff = 1e-05, string file = __FILE__, size_t line = __LINE__);` +#### `T approxEqual(U)(U other, U maxRelDiff = CommonDefaultFor!(T,U), U maxAbsDiff = 0.0, string file = __FILE__, size_t line = __LINE__);` -Asserts for aproximated equality of float types. Returns the value wrapped around the -assertion. +Asserts for approximated equality of float types. Returns the value wrapped around the +assertion. See Phobos std.math.isClose(). ```d (1.0f).should.be.approxEqual(1.00000001); -(1.0f).should.not.be.approxEqual(1.001); +(1.0f).should.not.be.approxEqual(1.01); ``` +#### `T close(U)(U other, U maxRelDiff = CommonDefaultFor!(T,U), U maxAbsDiff = 0.0, string file = __FILE__, size_t line = __LINE__);` + +Alias of approxEqual #### `T exist(string file = __FILE__, size_t line = __LINE__);` diff --git a/docs/pijamas.html b/docs/pijamas.html index 99020e2..c5f7161 100644 --- a/docs/pijamas.html +++ b/docs/pijamas.html @@ -755,7 +755,7 @@

Declaration

- @trusted T approxEqual(U = double)(U other, U maxRelDiff = 0.01, U maxAbsDiff = 1e-05, string file = __FILE__, size_t line = __LINE__) if (is(T : real) && __traits(isFloating, T) && is(U : real) && __traits(isFloating, U)); + @trusted T approxEqual(U = double)(U other, U maxRelDiff = CommonDefaultFor!(T, U), U maxAbsDiff = 0.0, string file = __FILE__, size_t line = __LINE__) if (is(T : real) && __traits(isFloating, T) && is(U : real) && __traits(isFloating, U));

@@ -771,6 +771,89 @@

Declaration

+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + +
+ + U other + + +
+

+ Value to compare to compare. +

+
+
+ + U maxRelDiff + + +
+

+ Maximum allowable relative difference. + Setting to 0.0 disables this check. Default depends on the type of + other and the original valie: It is approximately half the number of decimal digits of + precision of the smaller type. +

+
+
+ + U maxAbsDiff + + +
+

+ Maximum absolute difference. This is mainly usefull + for comparing values to zero. Setting to 0.0 disables this check. + Defaults to 0.0. +

+
+
+ + string file + + +
+

+ filename +

+
+
+ + size_t line + + +
+

+ line number inside of file +

+
+
+

Examples

@@ -780,7 +863,7 @@

Examples

  1. double d = 0.1; -double d2 = d + 1e-05; +double d2 = d + 1e-10; d.should.not.be.equal(d2); d.should.be.approxEqual(d2);
    2. @@ -795,6 +878,58 @@

    Examples

+
  • +
    +
    + close +
    +
    +
    +
    +

    Declaration

    +
    +

    + + alias close = approxEqual; + + +

    +
    +
    +
    +
    +
    +
    +
    +

    + Alias to approxEqual + +

    +
    +
    +

    Examples

    +

    + +

    +
    +
    +
      +
    1. double d = 0.1; +double d2 = d + 1e-10; +d.should.not.be.close(d2); +d.should.be.close(d2); +
      2. +
    +
    +
    +
    + +

    +
    +
    + +
    +
  • diff --git a/source/pijamas.d b/source/pijamas.d index dcda78c..b18455a 100644 --- a/source/pijamas.d +++ b/source/pijamas.d @@ -145,11 +145,13 @@ class Assertion(T) * maxAbsDiff = Maximum absolute difference. This is mainly usefull * for comparing values to zero. Setting to 0.0 disables this check. * Defaults to `0.0`. + * file = filename + * line = line number inside of file * * Examples: * ``` * double d = 0.1; - * double d2 = d + 1e-05; + * double d2 = d + 1e-10; * d.should.not.be.equal(d2); * d.should.be.approxEqual(d2); * ``` @@ -163,7 +165,18 @@ class Assertion(T) this.ok(isClose(context, other, maxRelDiff, maxAbsDiff), this.message(other), file, line); return context; } - ///ditto + + /** + * Alias to approxEqual + * + * Examples: + * ``` + * double d = 0.1; + * double d2 = d + 1e-10; + * d.should.not.be.close(d2); + * d.should.be.close(d2); + * ``` + */ alias close = approxEqual; /**