octave-maintainers
[Top][All Lists]
Advanced

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

Re: @example's as doctests


From: Oliver Heimlich
Subject: Re: @example's as doctests
Date: Tue, 05 May 2015 07:59:22 +0200
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Icedove/31.6.0

On 04.05.2015 22:30, Colin Macdonald wrote:
On 03/05/15 02:17, Oliver Heimlich wrote:
can you add functionality for testing @example blocks within .texi
files? I would like to also check my package manual, which contains
several @example blocks.

Ok, here is my merge-request to upstream.

https://github.com/catch22/doctest-for-matlab/pull/17
>

Colin, two remarks on your solution:

1. The file extension .texi seems to be the standard one, but you should also allow .texinfo, .tex and .txi [1]. An alternative solution would be to scan the first row for “\input texinfo”.

2. My texinfo examples contain no whitespace at the beginning of input rows and are thus not detected if they contain no “>>”. You should add an additional space after the automatically inserted “>>” to make that work.

Oliver


P.S. I have >260 files to check. A summary at the end of the file list (FAIL count) would help me check whether there are errors at all.

P.P.S. Good job and very useful tool!


[1] www.gnu.org/software/texinfo/manual/texinfo/html_node/Minimum.html



reply via email to

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