Skip to content

Commit

Permalink
Fixed a few problems in docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
svetlyak40wt committed Apr 15, 2021
1 parent d8a3734 commit 3ddf559
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion src/builder.lisp
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
(defsection @generating-documentation
(:title "Generating Documentation")
"Two convenience functions are provided to serve the common case of
having an ASDF system with some readmes and a directory with for the
having an ASDF system with some readmes and a directory for the
HTML documentation and the default css stylesheet."
(update-asdf-system-html-docs function)
(update-asdf-system-readme function)
Expand Down
8 changes: 4 additions & 4 deletions src/core.lisp
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
40ANTS-DOC/DOC:@EXTENSION-API) until documentation is generated, so it is
allowed to refer to things yet to be defined.
If EXPORT is true (the default), the referenced symbols and NAME are
If :EXPORT is true (the default), the referenced symbols and NAME are
candidates for exporting. A candidate symbol is exported if
- it is accessible in PACKAGE (it's not `OTHER-PACKAGE:SOMETHING`)
Expand All @@ -77,13 +77,13 @@
locative whose type is approved by EXPORTABLE-LOCATIVE-TYPE-P.
The idea with confounding documentation and exporting is to force
documentation of all exported symbols. EXPORT argument will cause
documentation of all exported symbols. :EXPORT argument will cause
[package variance](http://www.sbcl.org/manual/#Package-Variance)
error on SBCL. To prevent it, use UIOP:DEFINE-PACKAGE instead
of CL:DEFPACKAGE.
TITLE is a non-marked-up string or NIL. If non-NIL, it determines
the text of the heading in the generated output. LINK-TITLE-TO is a
:TITLE is a non-marked-up string or NIL. If non-NIL, it determines
the text of the heading in the generated output. :LINK-TITLE-TO is a
reference given as an
`(OBJECT LOCATIVE)` pair or NIL, to which the heading will link when
generating HTML. If not specified, the heading will link to its own
Expand Down

0 comments on commit 3ddf559

Please sign in to comment.