Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Feb 21, 2022
1 parent 7b67812 commit 65fbc76
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 12 deletions.
9 changes: 9 additions & 0 deletions ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

# ChangeLog

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

## 0.9.0 (2022-02-21)

* Now you can refer internal documentation section of other libraries.
To do this, put the link to this library documentation to the
`EXTERNAL-DOCS` argument of [`40ants-doc:defsection`][4e8b] macro and then
mention other section like this: `40ANTS-CI::@CRITIC section`.

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

## 0.8.0 (2022-02-14)
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,36 +199,36 @@ choose which.

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

## [class](365e) `foo-random:foo-random-state` ()
## [class](aced) `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](3a34) `foo-random:state` (foo-random-state) ()
## [reader](e398) `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](0097) `common-lisp:print-object` (object foo-random-state) stream
## [method](84cf) `common-lisp:print-object` (object foo-random-state) stream

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

## [variable](fd22) `foo-random:*foo-state*` #<foo-random-state >
## [variable](e938) `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](5cd6) `foo-random:gaussian-random` stddev &key (random-state \*foo-state\*)
## [function](2ce9) `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](6aff) `foo-random:uniform-random` limit &key (random-state \*foo-state\*)
## [function](12b0) `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 @@ -251,12 +251,12 @@ with `FOO`:
```

[2133]: #x-28FOO-RANDOM-3A-2AFOO-STATE-2A-20-28VARIABLE-29-29
[365e]: https://github.com/40ants/doc/blob/1a6b089f6cf104270eee5d082f0bdada84c8d097/tutorial.lisp#L34
[3a34]: https://github.com/40ants/doc/blob/1a6b089f6cf104270eee5d082f0bdada84c8d097/tutorial.lisp#L35
[0097]: https://github.com/40ants/doc/blob/1a6b089f6cf104270eee5d082f0bdada84c8d097/tutorial.lisp#L38
[fd22]: https://github.com/40ants/doc/blob/1a6b089f6cf104270eee5d082f0bdada84c8d097/tutorial.lisp#L41
[6aff]: https://github.com/40ants/doc/blob/1a6b089f6cf104270eee5d082f0bdada84c8d097/tutorial.lisp#L44
[5cd6]: https://github.com/40ants/doc/blob/1a6b089f6cf104270eee5d082f0bdada84c8d097/tutorial.lisp#L50
[aced]: https://github.com/40ants/doc/blob/7b67812ea9084c3e161db4ac16b41706120ba10d/tutorial.lisp#L34
[e398]: https://github.com/40ants/doc/blob/7b67812ea9084c3e161db4ac16b41706120ba10d/tutorial.lisp#L35
[84cf]: https://github.com/40ants/doc/blob/7b67812ea9084c3e161db4ac16b41706120ba10d/tutorial.lisp#L38
[e938]: https://github.com/40ants/doc/blob/7b67812ea9084c3e161db4ac16b41706120ba10d/tutorial.lisp#L41
[12b0]: https://github.com/40ants/doc/blob/7b67812ea9084c3e161db4ac16b41706120ba10d/tutorial.lisp#L44
[2ce9]: https://github.com/40ants/doc/blob/7b67812ea9084c3e161db4ac16b41706120ba10d/tutorial.lisp#L50
````
`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 65fbc76

Please sign in to comment.