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 14, 2024
1 parent ed68e5d commit 98dfc68
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 @@ -2,6 +2,12 @@

# ChangeLog

<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](fede) `foo-random:foo-random-state` ()
## [class](49a3) `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](eb01) `foo-random:state` (foo-random-state) ()
## [reader](5325) `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](4695) `common-lisp:print-object` (object foo-random-state) stream
## [method](ca4c) `common-lisp:print-object` (object foo-random-state) stream

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

## [variable](c7b7) `foo-random:*foo-state*` #<foo-random-state >
## [variable](bbb1) `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](a8e9) `foo-random:gaussian-random` stddev &key (random-state \*foo-state\*)
## [function](df7a) `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](a8f2) `foo-random:uniform-random` limit &key (random-state \*foo-state\*)
## [function](29e6) `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
[fede]: https://github.com/40ants/doc/blob/7b7caed4ec7745a46ce7dab3b8d5b07c54ee9a86/full/tutorial.lisp#L35
[eb01]: https://github.com/40ants/doc/blob/7b7caed4ec7745a46ce7dab3b8d5b07c54ee9a86/full/tutorial.lisp#L36
[4695]: https://github.com/40ants/doc/blob/7b7caed4ec7745a46ce7dab3b8d5b07c54ee9a86/full/tutorial.lisp#L39
[c7b7]: https://github.com/40ants/doc/blob/7b7caed4ec7745a46ce7dab3b8d5b07c54ee9a86/full/tutorial.lisp#L42
[a8f2]: https://github.com/40ants/doc/blob/7b7caed4ec7745a46ce7dab3b8d5b07c54ee9a86/full/tutorial.lisp#L45
[a8e9]: https://github.com/40ants/doc/blob/7b7caed4ec7745a46ce7dab3b8d5b07c54ee9a86/full/tutorial.lisp#L51
[49a3]: https://github.com/40ants/doc/blob/ed68e5d3572b7f48a8d606d86fc1191098367ab3/full/tutorial.lisp#L35
[5325]: https://github.com/40ants/doc/blob/ed68e5d3572b7f48a8d606d86fc1191098367ab3/full/tutorial.lisp#L36
[ca4c]: https://github.com/40ants/doc/blob/ed68e5d3572b7f48a8d606d86fc1191098367ab3/full/tutorial.lisp#L39
[bbb1]: https://github.com/40ants/doc/blob/ed68e5d3572b7f48a8d606d86fc1191098367ab3/full/tutorial.lisp#L42
[29e6]: https://github.com/40ants/doc/blob/ed68e5d3572b7f48a8d606d86fc1191098367ab3/full/tutorial.lisp#L45
[df7a]: https://github.com/40ants/doc/blob/ed68e5d3572b7f48a8d606d86fc1191098367ab3/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 98dfc68

Please sign in to comment.