Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Jun 5, 2023
1 parent 199decb commit 7f7a782
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 12 deletions.
11 changes: 11 additions & 0 deletions ChangeLog.md
View file
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-2E14-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.14.0 (2023-06-04)

* Added [`40ants-doc:*symbols-with-ignored-missing-locations*`][24f5] variable to ignore warnings on missing source location.

This might be useful for autogenerated methods. For example, Mito does generate such reader methods
[here][c8a6].

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

## 0.13.0 (2023-06-04)
Expand Down Expand Up @@ -305,6 +314,7 @@ of [`40ants-doc-full/builder:render-to-files`][6a41] function.
[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
[24f5]: https://40ants.com/doc/#x-2840ANTS-DOC-3A-2ASYMBOLS-WITH-IGNORED-MISSING-LOCATIONS-2A-20-28VARIABLE-29-29
[4e8b]: https://40ants.com/doc/#x-2840ANTS-DOC-3ADEFSECTION-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29
[ad02]: https://40ants.com/doc/#x-2840ANTS-DOC-3ADEFSECTION-COPY-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29
[c292]: https://40ants.com/doc/#x-2840ANTS-DOC-FULL-2FBUILDER-3AGET-CURRENT-ASDF-SYSTEM-20FUNCTION-29
Expand All @@ -314,6 +324,7 @@ of [`40ants-doc-full/builder:render-to-files`][6a41] function.
[3855]: https://40ants.com/doc/#x-2840ANTS-DOC-FULL-2FCOMMONDOC-2FMAPPER-3ANODE-SUPPORTS-CHILDREN-20GENERIC-FUNCTION-29
[6e29]: https://40ants.com/doc/#x-2840ANTS-DOC-FULL-2FTHEMES-2FDOCS-3A-3A-40DEFINING-A-THEME-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29
[2fa5]: https://github.com/40ants/40ants-doc-theme-40ants/commit/917a4c1e72b0379f509bdee4864531e641c9ec4e#diff-47d16baea2d4ef710747f19c24df8cf7ef4f6bbbfd1dbb0ade55f47457b1e8feR155-R161
[c8a6]: https://github.com/fukamachi/mito/blob/6835d2c8120454e93c69d4f22cccb10d9ee24526/src/core/dao/mixin.lisp#L71
[7927]: https://github.com/melisgl/mgl-pax
[140c]: https://www.sphinx-doc.org/

Expand Down
24 changes: 12 additions & 12 deletions README.md
View file
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](c6fe) `foo-random:foo-random-state` ()
## [class](aa68) `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](41ce) `foo-random:state` (foo-random-state) ()
## [reader](2ea8) `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](ab10) `common-lisp:print-object` (object foo-random-state) stream
## [method](db6d) `common-lisp:print-object` (object foo-random-state) stream

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

## [variable](8f38) `foo-random:*foo-state*` #<foo-random-state >
## [variable](644a) `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](26a6) `foo-random:gaussian-random` stddev &key (random-state \*foo-state\*)
## [function](31d9) `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](6366) `foo-random:uniform-random` limit &key (random-state \*foo-state\*)
## [function](2e04) `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
[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
[aa68]: https://github.com/40ants/doc/blob/199decb1d4678fde1a1e3bd2cc76d3265484d3d6/full/tutorial.lisp#L35
[2ea8]: https://github.com/40ants/doc/blob/199decb1d4678fde1a1e3bd2cc76d3265484d3d6/full/tutorial.lisp#L36
[db6d]: https://github.com/40ants/doc/blob/199decb1d4678fde1a1e3bd2cc76d3265484d3d6/full/tutorial.lisp#L39
[644a]: https://github.com/40ants/doc/blob/199decb1d4678fde1a1e3bd2cc76d3265484d3d6/full/tutorial.lisp#L42
[2e04]: https://github.com/40ants/doc/blob/199decb1d4678fde1a1e3bd2cc76d3265484d3d6/full/tutorial.lisp#L45
[31d9]: https://github.com/40ants/doc/blob/199decb1d4678fde1a1e3bd2cc76d3265484d3d6/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 7f7a782

Please sign in to comment.