crc/retroforth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: make it clear that unu does not support out of order sections

Browse source 
FossilOrigin-Name: 5333329003769c24f65d52a077e7bbd3e9fc8b171c6537bc5247a7a7acf96d8e
This commit is contained in:
crc 2024-04-02 10:17:50 +00:00
parent a019adeeb3
commit 43d64b287b
3 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/book/toolchain/info/retro-unu
View file

@ -5,6 +5,9 @@ are in a format called Unu. This allows easy mixing of
commentary and code blocks, making it simple to document commentary and code blocks, making it simple to document
the code. the code.
The Unu format does not support writing code and commentary "out
of order".
As an example, As an example,
# Determine The Average Word Name Length # Determine The Average Word Name Length

3
doc/book/toolchain/man/retro-unu
View file

@ -13,6 +13,9 @@ DESCRIPTION
retro-unu is a tool for extracting code from fenced blocks in literate retro-unu is a tool for extracting code from fenced blocks in literate
sources. It will write output to stdout. sources. It will write output to stdout.
retro-unu does not support "out of order" structuring of code, commentary,
and test blocks.
AUTHORS AUTHORS
Charles Childers <crc@forthworks.com> Charles Childers <crc@forthworks.com>

5
man/retro-unu.1
View file

@ -19,6 +19,11 @@ write output to stdout.
A code block starts with ~~~ on a line by itself and ends with A code block starts with ~~~ on a line by itself and ends with
a second ~~~. Test blocks start and end with ```. a second ~~~. Test blocks start and end with ```.
.Nm
does not support "out of order" structuring of the code,
commentary, and test blocks.
.Sh OPTIONS .Sh OPTIONS
.Bl -tag -width -indent .Bl -tag -width -indent
.It Fl t .It Fl t