octave-maintainers
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: doctest and @example blocks without an actual cope and paste example


From: Colin Macdonald
Subject: Re: doctest and @example blocks without an actual cope and paste example
Date: Thu, 9 Jul 2015 14:49:02 +0100
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:38.0) Gecko/20100101 Thunderbird/38.0.1

On 09/07/15 14:33, 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]:

     A bottom hat transform corresponds to the difference between the closing
     of @var{img} and @var{img} itself, i.e., it is equivalent to:
     @example
     imclose (img, se) - img;
     @end example

which causes an extraction error.

Easiest thing is to mark them with:

  # doctest: +SKIP

or

  @c doctest: +SKIP"

I complained about this elsewhere and started replacing such things, (especially the common @ifnotex) with @verbatim. But unfortunately that doesn't format quite the same.

Colin



reply via email to

[Prev in Thread] Current Thread [Next in Thread]