Re: [code] [textadept] Odd stuff happening with escape sequences in API documentation files

From: Gabriel Bertilson <arboreous.philologist.att.gmail.com>
Date: Wed, 20 Feb 2019 15:02:52 -0600

Thank you! I didn't realize the C documentation was written by hand.
As a newbie I've found it very helpful.

— Gabriel

— Gabriel

On Sat, Feb 16, 2019 at 10:50 PM Mitchell <m.att.foicica.com> wrote:
>
> Hi Gabriel,
>
> On Tue, 29 Jan 2019, Gabriel Bertilson wrote:
>
> > Some escape sequences in the documentation for the Lua C API and Lua
> > libraries are not correctly rendered in Textadept's API documentation.
> >
> > For instance, in the examples in the documentation for
> > `string.format`, `\n` in an example displays as a newline and
> > backslash-newline-spaces is transformed into `\n`- spaces. Similarly,
> > in the documentation for `lua_getinfo`, `\n` in the example is
> > displayed as a newline. Oddly, `\n` is treated correctly in the
> > documentation for `lua_next`. I think there was a similar case in the
> > documentation for the C standard libraries but I can't remember where.
> >
> > I guess whatever script generates the documentation is not correctly
> > escaping things when generating one-line documentation for each
> > symbol, but I can't figure out any rhyme or reason to it.
>
> I've committed a fix[1]. The C API is generated by hand, so please forgive me if I missed something. The Lua API generator should be fixed.
>
> Cheers,
> Mitchell
>
> [1]: https://foicica.com/hg/textadept/rev/b7bd2073069c
> --
> You are subscribed to code.att.foicica.com.
> To change subscription settings, send an e-mail to code+help.att.foicica.com.
> To unsubscribe, send an e-mail to code+unsubscribe.att.foicica.com.
>

-- 
You are subscribed to code.att.foicica.com.
To change subscription settings, send an e-mail to code+help.att.foicica.com.
To unsubscribe, send an e-mail to code+unsubscribe.att.foicica.com.
Received on Wed 20 Feb 2019 - 16:02:52 EST

This archive was generated by hypermail 2.2.0 : Thu 21 Feb 2019 - 06:38:09 EST