Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jan 26, 2024
1 parent 8c0063f commit 8c6ad24
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,36 +198,36 @@ choose which.

<a id="x-28FOO-RANDOM-3AFOO-RANDOM-STATE-20CLASS-29"></a>

## [class](936f) `foo-random:foo-random-state` ()
## [class](7e0a) `foo-random:foo-random-state` ()

<a id="x-28FOO-RANDOM-3ASTATE-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20FOO-RANDOM-3AFOO-RANDOM-STATE-29-29"></a>

## [reader](1e16) `foo-random:state` (foo-random-state) ()
## [reader](ac3a) `foo-random:state` (foo-random-state) ()

Returns random foo's state.

Hey we can also print states!

<a id="x-28PRINT-OBJECT-20-28METHOD-20NIL-20-28FOO-RANDOM-3AFOO-RANDOM-STATE-20T-29-29-29"></a>

## [method](a564) `common-lisp:print-object` (object foo-random-state) stream
## [method](9a0f) `common-lisp:print-object` (object foo-random-state) stream

<a id="x-28FOO-RANDOM-3A-2AFOO-STATE-2A-20-28VARIABLE-29-29"></a>

## [variable](4a0c) `foo-random:*foo-state*` #<foo-random-state >
## [variable](0247) `foo-random:*foo-state*` #<foo-random-state >

Much like `*RANDOM-STATE*` but uses the `FOO` algorithm.

<a id="x-28FOO-RANDOM-3AGAUSSIAN-RANDOM-20FUNCTION-29"></a>

## [function](bfa6) `foo-random:gaussian-random` stddev &key (random-state \*foo-state\*)
## [function](8df1) `foo-random:gaussian-random` stddev &key (random-state \*foo-state\*)

Return not a random number from a zero mean normal distribution with
`STDDEV`.

<a id="x-28FOO-RANDOM-3AUNIFORM-RANDOM-20FUNCTION-29"></a>

## [function](4e37) `foo-random:uniform-random` limit &key (random-state \*foo-state\*)
## [function](ec39) `foo-random:uniform-random` limit &key (random-state \*foo-state\*)

Return a random number from the between 0 and `LIMIT` (exclusive)
uniform distribution.
Expand All @@ -250,12 +250,12 @@ with `FOO`:
```

[2133]: #x-28FOO-RANDOM-3A-2AFOO-STATE-2A-20-28VARIABLE-29-29
[936f]: https://github.com/40ants/doc/blob/bc58b407f6c6738b33d34c954ddcb4e984d4967e/full/tutorial.lisp#L35
[1e16]: https://github.com/40ants/doc/blob/bc58b407f6c6738b33d34c954ddcb4e984d4967e/full/tutorial.lisp#L36
[a564]: https://github.com/40ants/doc/blob/bc58b407f6c6738b33d34c954ddcb4e984d4967e/full/tutorial.lisp#L39
[4a0c]: https://github.com/40ants/doc/blob/bc58b407f6c6738b33d34c954ddcb4e984d4967e/full/tutorial.lisp#L42
[4e37]: https://github.com/40ants/doc/blob/bc58b407f6c6738b33d34c954ddcb4e984d4967e/full/tutorial.lisp#L45
[bfa6]: https://github.com/40ants/doc/blob/bc58b407f6c6738b33d34c954ddcb4e984d4967e/full/tutorial.lisp#L51
[7e0a]: https://github.com/40ants/doc/blob/8c0063f77bbc5dab810e3d5439f54daed9b3cf76/full/tutorial.lisp#L35
[ac3a]: https://github.com/40ants/doc/blob/8c0063f77bbc5dab810e3d5439f54daed9b3cf76/full/tutorial.lisp#L36
[9a0f]: https://github.com/40ants/doc/blob/8c0063f77bbc5dab810e3d5439f54daed9b3cf76/full/tutorial.lisp#L39
[0247]: https://github.com/40ants/doc/blob/8c0063f77bbc5dab810e3d5439f54daed9b3cf76/full/tutorial.lisp#L42
[ec39]: https://github.com/40ants/doc/blob/8c0063f77bbc5dab810e3d5439f54daed9b3cf76/full/tutorial.lisp#L45
[8df1]: https://github.com/40ants/doc/blob/8c0063f77bbc5dab810e3d5439f54daed9b3cf76/full/tutorial.lisp#L51
````
`MGL-PAX` supported the plain text format which was more readble when viewed
from a simple text editor, but I've dropped support for plain text in this fork
Expand Down

0 comments on commit 8c6ad24

Please sign in to comment.