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 4, 2024
1 parent 374d069 commit d009833
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 12 deletions.
7 changes: 7 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-2E16-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.16.0 (2024-05-04)

* A generic-function [`40ants-doc/locatives/asdf-system:asdf-system-documentation-title`][530f] was added. It allows to override the text of a section showing an information about `ASDF` system.

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

## 0.15.4 (2024-01-26)
Expand Down Expand Up @@ -303,6 +309,7 @@ of [`40ants-doc-full/builder:render-to-files`][6a41] function.
[813d]: https://40ants.com/doc/#x-2840ANTS-DOC-2FAUTODOC-3ADEFAUTODOC-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29
[8c40]: https://40ants.com/doc/#x-2840ANTS-DOC-2FCHANGELOG-3ADEFCHANGELOG-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29
[dc59]: https://40ants.com/doc/#x-2840ANTS-DOC-2FIGNORED-WORDS-3AIGNORE-WORDS-IN-PACKAGE-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29
[530f]: https://40ants.com/doc/#x-2840ANTS-DOC-2FLOCATIVES-2FASDF-SYSTEM-3AASDF-SYSTEM-DOCUMENTATION-TITLE-20GENERIC-FUNCTION-29
[b3bb]: https://40ants.com/doc/#x-2840ANTS-DOC-2FLOCATIVES-2FBASE-3ALOCATIVE-ARGS-20GENERIC-FUNCTION-29
[0796]: https://40ants.com/doc/#x-2840ANTS-DOC-2FLOCATIVES-2FBASE-3ALOCATIVE-TYPE-20GENERIC-FUNCTION-29
[359f]: https://40ants.com/doc/#x-2840ANTS-DOC-2FLOCATIVES-3AINCLUDE-20-2840ANTS-DOC-2FLOCATIVES-3ALOCATIVE-29-29
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](98a6) `foo-random:foo-random-state` ()
## [class](c978) `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](5aa7) `foo-random:state` (foo-random-state) ()
## [reader](e9df) `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](0c07) `common-lisp:print-object` (object foo-random-state) stream
## [method](809a) `common-lisp:print-object` (object foo-random-state) stream

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

## [variable](7443) `foo-random:*foo-state*` #<foo-random-state >
## [variable](aa3a) `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](a391) `foo-random:gaussian-random` stddev &key (random-state \*foo-state\*)
## [function](c3b2) `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](66c5) `foo-random:uniform-random` limit &key (random-state \*foo-state\*)
## [function](9f80) `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
[98a6]: https://github.com/40ants/doc/blob/ac2588f4843e14544615c642911140baeb371b7e/full/tutorial.lisp#L35
[5aa7]: https://github.com/40ants/doc/blob/ac2588f4843e14544615c642911140baeb371b7e/full/tutorial.lisp#L36
[0c07]: https://github.com/40ants/doc/blob/ac2588f4843e14544615c642911140baeb371b7e/full/tutorial.lisp#L39
[7443]: https://github.com/40ants/doc/blob/ac2588f4843e14544615c642911140baeb371b7e/full/tutorial.lisp#L42
[66c5]: https://github.com/40ants/doc/blob/ac2588f4843e14544615c642911140baeb371b7e/full/tutorial.lisp#L45
[a391]: https://github.com/40ants/doc/blob/ac2588f4843e14544615c642911140baeb371b7e/full/tutorial.lisp#L51
[c978]: https://github.com/40ants/doc/blob/374d069d67b108bbb777694959448663c81637a4/full/tutorial.lisp#L35
[e9df]: https://github.com/40ants/doc/blob/374d069d67b108bbb777694959448663c81637a4/full/tutorial.lisp#L36
[809a]: https://github.com/40ants/doc/blob/374d069d67b108bbb777694959448663c81637a4/full/tutorial.lisp#L39
[aa3a]: https://github.com/40ants/doc/blob/374d069d67b108bbb777694959448663c81637a4/full/tutorial.lisp#L42
[9f80]: https://github.com/40ants/doc/blob/374d069d67b108bbb777694959448663c81637a4/full/tutorial.lisp#L45
[c3b2]: https://github.com/40ants/doc/blob/374d069d67b108bbb777694959448663c81637a4/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 d009833

Please sign in to comment.