Add Documentation (#13811)

* Add more Docs and runnableExamples
2020-03-31 10:47:57 -03:00 · 2020-03-31 10:47:57 -03:00 · 42d2c3088e
commit 42d2c3088e
parent 1e4093d949
12 changed files with 135 additions and 19 deletions
--- a/lib/pure/mersenne.nim
+++ b/lib/pure/mersenne.nim
@ -39,6 +39,14 @@ proc getNum*(m: var MersenneTwister): uint32 =
  result = result xor ((result shl 15'u32) and 0xefc60000'u32)
  result = result xor (result shr 18'u32)

+
+runnableExamples:
+  static:
+    block:
+      var rando: MersenneTwister = newMersenneTwister(uint32.high)  ## Must be "var".
+      doAssert rando.getNum() != rando.getNum()  ## Pseudo random number. Works at compile-time.
+
+
 # Test
 when not defined(testing) and isMainModule:
  var mt = newMersenneTwister(2525)