|
From: | Colin Macdonald |
Subject: | Re: doctest and @example blocks without an actual cope and paste example |
Date: | Thu, 9 Jul 2015 14:51:30 +0100 |
User-agent: | Mozilla/5.0 (X11; Linux x86_64; rv:38.0) Gecko/20100101 Thunderbird/38.0.1 |
On 09/07/15 14:46, Mike Miller wrote:
On Thu, Jul 09, 2015 at 14:33:19 +0100, Carnë Draug wrote:doctest extracts code from @example blocks. However, @example is also used to display definitions as in the following case from imbothat [1]:[…]Point is, despite the name, @example is not being used only for examples. Am I using TexInfo incorrectly? What would be the best way to do this?It's also used throughout Octave to display math formulas in ASCII art format:
Here's what I said about this in https://savannah.gnu.org/patch/?8666
One thing that's clear is @example gets used as an alternative to tex. This is not semantically correct. I've replaced with @verbatim which sounds about right. But it doesn't indent like @example does. Here I've just moved them in manually roughly the same number of spaces, which doesn't feel right. What is the right thing to do? New @ environment? New formatting for @verbatim to match the @example intend?
[Prev in Thread] | Current Thread | [Next in Thread] |