Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed May 15, 2024
1 parent d7cefb4 commit 1311ac9
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 12 deletions.
6 changes: 6 additions & 0 deletions ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@

* Update 2

<a id="x-2840ANTS-DOC-2FCHANGELOG-3A-3A-7C0-2E17-2E3-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.17.3 (2024-05-15)

* Update 2

<a id="x-2840ANTS-DOC-2FCHANGELOG-3A-3A-7C0-2E17-2E2-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.17.2 (2024-05-15)
Expand Down
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](54d9) `foo-random:foo-random-state` ()
## [class](f3bf) `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](d8e0) `foo-random:state` (foo-random-state) ()
## [reader](e62e) `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](a0a5) `common-lisp:print-object` (object foo-random-state) stream
## [method](1c23) `common-lisp:print-object` (object foo-random-state) stream

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

## [variable](df0a) `foo-random:*foo-state*` #<foo-random-state >
## [variable](2589) `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](ab10) `foo-random:gaussian-random` stddev &key (random-state \*foo-state\*)
## [function](c2c5) `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](7ae4) `foo-random:uniform-random` limit &key (random-state \*foo-state\*)
## [function](d756) `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
[54d9]: https://github.com/40ants/doc/blob/d097b155eec8416a0db051e88bfae9ab135eb64d/full/tutorial.lisp#L35
[d8e0]: https://github.com/40ants/doc/blob/d097b155eec8416a0db051e88bfae9ab135eb64d/full/tutorial.lisp#L36
[a0a5]: https://github.com/40ants/doc/blob/d097b155eec8416a0db051e88bfae9ab135eb64d/full/tutorial.lisp#L39
[df0a]: https://github.com/40ants/doc/blob/d097b155eec8416a0db051e88bfae9ab135eb64d/full/tutorial.lisp#L42
[7ae4]: https://github.com/40ants/doc/blob/d097b155eec8416a0db051e88bfae9ab135eb64d/full/tutorial.lisp#L45
[ab10]: https://github.com/40ants/doc/blob/d097b155eec8416a0db051e88bfae9ab135eb64d/full/tutorial.lisp#L51
[f3bf]: https://github.com/40ants/doc/blob/d7cefb457b689163f7a7d4e947d59a1b3a21380b/full/tutorial.lisp#L35
[e62e]: https://github.com/40ants/doc/blob/d7cefb457b689163f7a7d4e947d59a1b3a21380b/full/tutorial.lisp#L36
[1c23]: https://github.com/40ants/doc/blob/d7cefb457b689163f7a7d4e947d59a1b3a21380b/full/tutorial.lisp#L39
[2589]: https://github.com/40ants/doc/blob/d7cefb457b689163f7a7d4e947d59a1b3a21380b/full/tutorial.lisp#L42
[d756]: https://github.com/40ants/doc/blob/d7cefb457b689163f7a7d4e947d59a1b3a21380b/full/tutorial.lisp#L45
[c2c5]: https://github.com/40ants/doc/blob/d7cefb457b689163f7a7d4e947d59a1b3a21380b/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 1311ac9

Please sign in to comment.