Re: Texinfo 5 and deftypefnx

[Rik]

3/24/13

The fix is conceptually simple.  Texinfo 5 does not allow separating
@deftypefn and @deftypefnx entries.  Most of the time the documentation is
written as

@deftypefn ...
@deftypefnx ...
...
@end deftypefn

Occasionally, however, the documentation is

@deftypefn ...
Some documentation lines
@deftypefnx ...
Some more documentation lines
@end deftypefn

To change the second form into the first form requires moving the
@deftypefnx entries to be adjacent to the @deftypefn entry -- which is
easy.  Unfortunately it also requires re-writing the documentation lines so
that the sentences still make sense.  That was a little harder which is why
it hasn't been done.

--Rik

On 03/24/2013 09:56 AM, address@hidden wrote:
> Message: 5
> Date: Sun, 24 Mar 2013 12:55:54 -0400
> From: Amod Mulay <address@hidden>
> To: skinduptruk <address@hidden>
> Cc: Octave Maintainers List <address@hidden>
> Subject: Re: texinfo deftypefn vs deftypefnx on arch linux
> Message-ID:
>       <address@hidden>
> Content-Type: text/plain; charset="iso-8859-1"
>
> I already have on a patch for the doc. issues. Hope to get it pulled soon.
>
> thanks
> Amod
>
>
> On Sun, Mar 24, 2013 at 3:49 AM, skinduptruk <address@hidden> wrote:
>
>> > G'day all!
>> >
>> > first time post here, i have been lurking in the IRC and finally decided to
>> > try out Octave while getting back into linux via arch linux...
>> >
>> > i cloned from hg and after lots of pkg updates via pacman i finally got
>> > octave to build and run (a linux newbie POV of this process might be worth
>> > a
>> > separate write up!).  however i did need to roll back my texinfo to version
>> > 4 like in this bug report:
>> >
>> > http://savannah.gnu.org/bugs/?38392
>> >
>> > i think tex functions are worth learning more about, so this bug was of
>> > interest.  i'm no expert in tex, so with little experience in what to look
>> > for, i have not found many clues in the gnu.org help files like:
>> >
>> >
>> > http://www.gnu.org/software/texinfo/manual/texinfo/html_node/_0040deffnx.html#g_t_0040deffnx
>> >
>> >
>> > http://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_mono/texinfo.html#Definition%20Commands
>> >
>> > in the bug report there is mention of where to find the offending .m files,
>> > but any more ideas on the fix itself?  i'm thinking could be something
>> > simple like declaring the deftypefnx in a slightly different place or
>> > different way to achieve a similar final doc output?  any extra hints are
>> > welcome...
>> >
>> > Thanks,
>> > Kurt.
>> >
>> >
>> >
>> > --
>> > View this message in context:
>> > http://octave.1599824.n4.nabble.com/texinfo-deftypefn-vs-deftypefnx-on-arch-linux-tp4651158.html
>> > Sent from the Octave - Maintainers mailing list archive at Nabble.com.
>> >
> -------------- next part --------------
> An HTML attachment was scrubbed...
> URL: 
> <http://mailman.cae.wisc.edu/pipermail/octave-maintainers/attachments/20130324/78a1427c/attachment.html>
>
> ------------------------------
>
> _______________________________________________
> Octave-maintainers mailing list
> address@hidden
> https://mailman.cae.wisc.edu/listinfo/octave-maintainers