Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jun 3, 2023
1 parent db630f4 commit 1db487a
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-2E13-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.13.0 (2023-06-04)

* Support for variables was added to autodoc subsystem.

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

## 0.12.0 (2023-04-22)
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,36 +202,36 @@ choose which.

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

## [class](7bde) `foo-random:foo-random-state` ()
## [class](c6fe) `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](84dd) `foo-random:state` (foo-random-state) ()
## [reader](41ce) `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](e5e9) `common-lisp:print-object` (object foo-random-state) stream
## [method](ab10) `common-lisp:print-object` (object foo-random-state) stream

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

## [variable](cd96) `foo-random:*foo-state*` #<foo-random-state >
## [variable](8f38) `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](ee0a) `foo-random:gaussian-random` stddev &key (random-state \*foo-state\*)
## [function](26a6) `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](988f) `foo-random:uniform-random` limit &key (random-state \*foo-state\*)
## [function](6366) `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 @@ -254,12 +254,12 @@ with `FOO`:
```

[2133]: #x-28FOO-RANDOM-3A-2AFOO-STATE-2A-20-28VARIABLE-29-29
[7bde]: https://github.com/40ants/doc/blob/0a89b6586de2061385898f02fddd661b24e10503/full/tutorial.lisp#L35
[84dd]: https://github.com/40ants/doc/blob/0a89b6586de2061385898f02fddd661b24e10503/full/tutorial.lisp#L36
[e5e9]: https://github.com/40ants/doc/blob/0a89b6586de2061385898f02fddd661b24e10503/full/tutorial.lisp#L39
[cd96]: https://github.com/40ants/doc/blob/0a89b6586de2061385898f02fddd661b24e10503/full/tutorial.lisp#L42
[988f]: https://github.com/40ants/doc/blob/0a89b6586de2061385898f02fddd661b24e10503/full/tutorial.lisp#L45
[ee0a]: https://github.com/40ants/doc/blob/0a89b6586de2061385898f02fddd661b24e10503/full/tutorial.lisp#L51
[c6fe]: https://github.com/40ants/doc/blob/db630f41ef881b2f35202e97aa76a37052db116c/full/tutorial.lisp#L35
[41ce]: https://github.com/40ants/doc/blob/db630f41ef881b2f35202e97aa76a37052db116c/full/tutorial.lisp#L36
[ab10]: https://github.com/40ants/doc/blob/db630f41ef881b2f35202e97aa76a37052db116c/full/tutorial.lisp#L39
[8f38]: https://github.com/40ants/doc/blob/db630f41ef881b2f35202e97aa76a37052db116c/full/tutorial.lisp#L42
[6366]: https://github.com/40ants/doc/blob/db630f41ef881b2f35202e97aa76a37052db116c/full/tutorial.lisp#L45
[26a6]: https://github.com/40ants/doc/blob/db630f41ef881b2f35202e97aa76a37052db116c/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 1db487a

Please sign in to comment.