suzanne.soy/hyper-literate
1
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Documentation changes suggested by O. Andreescu. Thanks!

Browse Source
This commit is contained in:
Georges Dupéron 2016-08-15 01:24:18 +02:00
parent 861f1524f6
commit 2cc3a6b5e0
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
scribblings/hyper-literate.scrbl
View File

@ -56,7 +56,7 @@ the built-ins. The @racket[#:no-require-lang] option
disables that behaviour, and has the only drawback that disables that behaviour, and has the only drawback that
built-ins of the @racket[_lang] language do not have an built-ins of the @racket[_lang] language do not have an
arrow in DrRacket (but they still should be highlighted with arrow in DrRacket (but they still should be highlighted with
a turquoise background when hovered with the mouse). a turquoise background when hovered over with the mouse).
The current implementation of @racketmodname[scribble/lp2], The current implementation of @racketmodname[scribble/lp2],
on which @racketmodname[hyper-literate] relies (with a few on which @racketmodname[hyper-literate] relies (with a few
@ -65,8 +65,8 @@ chunks of code, and passes them to
@racket[(require (for-label …))]. The goal is to have @racket[(require (for-label …))]. The goal is to have
identifiers from required modules automatically highlighted identifiers from required modules automatically highlighted
and hyperlinked to their documentation. However, all and hyperlinked to their documentation. However, all
meta-levels are smashed into the @racket[#f] i.e. meta-levels are smashed into the @racket[#f], i.e.
@racket[for-syntax] meta-level. As a consequence, conflicts @racket[for-label] meta-level. As a consequence, conflicts
can arise at the @racket[for-label] meta-level between two can arise at the @racket[for-label] meta-level between two
modules, even if these two modules were originally required modules, even if these two modules were originally required
at distinct meta-levels in the source program. It is at distinct meta-levels in the source program. It is
@ -86,8 +86,8 @@ using non-linear, hyperlinked documents.
For now these utilities only help with manipulating literate For now these utilities only help with manipulating literate
programming chunks (e.g. repeating the same chunk in several programming chunks (e.g. repeating the same chunk in several
places in the output document, but keep a single copy in the places in the output document, but keeping a single copy in
source code). the source code).
Ultimately, the reading experience should be closer to Ultimately, the reading experience should be closer to
viewing an interactive presentation, focusing on the parts viewing an interactive presentation, focusing on the parts
@ -170,9 +170,9 @@ where they appear using @racket[racketblock].
The @racket[doc] submodule is declared using The @racket[doc] submodule is declared using
@racket[module*], so that it can use @racket[module*], so that it can use
@racket[(require (submod ".."))] to use functions declared @racket[(require (submod ".."))] to use functions declared
in the the chunks. For example, it should be possible to in the chunks. For example, it should be possible to
dynamically compute the result of a function, and insert it dynamically compute the result of a function, and to insert
into the document, so that the value displayed always it into the document, so that the value displayed always
matches the implementation. matches the implementation.
When the file is expanded for the first time, however, the When the file is expanded for the first time, however, the