[changeset] don't remove whitespace within @example in docstrings
Thorsten Meyer
thorsten.meyier at gmx.de
Fri Nov 28 13:57:24 CST 2008
Hi,
David Bateman wrote:
>> Thorsten Meyer wrote:
>>
>>> during the build process of octave, the documentation strings within
>>> the .m files are extracted by
>>> the script scripts/mkdoc. This scripts also removes white space
>>> before @-commands at the beginning
>>> of lines. The script also removes white space before @result{},
>>> which distorts the display of the
>>> @examples in the documentations strings.
>>>
>>> Included, you will find a changeset that fixes mkdoc, such that it
>>> no longer eats white space
>>> within @example environments.
>>>
> Doesn't this patch mean that the build process depends on PERL.
> Whereas at the moment the dependency on PERL is fairly weak.. Is that
> a good idea?
>
> Regards
> David
>
That's true. I replaced sed plus sh by perl (simply because I couldn't
figure out a way to do it with sed). I assumed, that any system, that
has sed would also have perl nowadays.
Thorsten
More information about the Octave-maintainers
mailing list