From 43d64b287b4e76b083a61febc2f10aa31122ed30 Mon Sep 17 00:00:00 2001 From: crc <> Date: Tue, 2 Apr 2024 10:17:50 +0000 Subject: [PATCH] docs: make it clear that unu does not support out of order sections FossilOrigin-Name: 5333329003769c24f65d52a077e7bbd3e9fc8b171c6537bc5247a7a7acf96d8e --- doc/book/toolchain/info/retro-unu | 3 +++ doc/book/toolchain/man/retro-unu | 3 +++ man/retro-unu.1 | 5 +++++ 3 files changed, 11 insertions(+) diff --git a/doc/book/toolchain/info/retro-unu b/doc/book/toolchain/info/retro-unu index 394d381..cf644d8 100644 --- a/doc/book/toolchain/info/retro-unu +++ b/doc/book/toolchain/info/retro-unu @@ -5,6 +5,9 @@ are in a format called Unu. This allows easy mixing of commentary and code blocks, making it simple to document the code. +The Unu format does not support writing code and commentary "out +of order". + As an example, # Determine The Average Word Name Length diff --git a/doc/book/toolchain/man/retro-unu b/doc/book/toolchain/man/retro-unu index 2fe213d..d9c53c3 100644 --- a/doc/book/toolchain/man/retro-unu +++ b/doc/book/toolchain/man/retro-unu @@ -13,6 +13,9 @@ DESCRIPTION retro-unu is a tool for extracting code from fenced blocks in literate sources. It will write output to stdout. + retro-unu does not support "out of order" structuring of code, commentary, + and test blocks. + AUTHORS Charles Childers diff --git a/man/retro-unu.1 b/man/retro-unu.1 index ce47272..6264067 100644 --- a/man/retro-unu.1 +++ b/man/retro-unu.1 @@ -19,6 +19,11 @@ write output to stdout. A code block starts with ~~~ on a line by itself and ends 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 .Bl -tag -width -indent .It Fl t