Re: [AD] Patch: Docs corrections and clarifications

[Polybios <polybios@xxxxxxxxxx>]

Thanks for applying!

Yes, "##" wasn't used in any other code block and indenting it by one 
space looked strange.
However, I've made a small patch (attached) to 
docs/scripts/make_single.c that fixes all of this by preventing it from 
preprocessing code blocks.
I've diffed the generated html-files before and after the change, there 
haven't been any side effects. On the contrary, it turned out I missed 
some truncated defines ("#defin", even appearing in red ^^) earlier.

Consequently, I've also removed the one space for every #include at the 
top that was probably added in order to prevent make_single.c from 
eating the 'e' of "#include".

Kind regards,
Polybios

@Elias:
I think the PDF/latex-links are generated by the same script.


On 03/13/2015 04:31 AM, SiegeLord wrote:
> Wow! That's a lot of fixes, thanks! I committed this with minor changes
> in a succeeding commit. One thing that puzzled me was the change in
> style for that INI example, was that because the # got turned to %?
>
> -SL
>
> On 03/12/2015 02:40 PM, Polybios wrote:
> > Dear developers,
> >
> > I'd like to submit this humble patch to the documentation. Basically,
> > I've simply gone through all of it, correcting all the (spelling)
> > mistakes I've noticed and adding some clarifications.
> > I've also added short and very basic introductory texts to three
> > sections. These might not be perfect and I don't particularly mind if
> > they will be included.
> >
> > By the way, it would be nice if we could link to non-API
> > headings/sections in a clean way (i.e. that will not only work with html
> > output); especially a link from the ALLEGRO_EVENT_KEY_... events to the
> > "Key codes" section is on my mind here.
> > But if I understand correctly, this is not possible with the current
> > setup of the doc-generating scripts.
> >
> > Kind regards,
> > Polybios
> >
> >
> >
> > ------------------------------------------------------------------------------
> > Dive into the World of Parallel Programming The Go Parallel Website, sponsored
> > by Intel and developed in partnership with Slashdot Media, is your hub for all
> > things parallel software development, from weekly thought leadership blogs to
> > news, videos, case studies, tutorials and more. Take a look and join the
> > conversation now. http://goparallel.sourceforge.net/
>
>
> ------------------------------------------------------------------------------
> Dive into the World of Parallel Programming The Go Parallel Website, sponsored
> by Intel and developed in partnership with Slashdot Media, is your hub for all
> things parallel software development, from weekly thought leadership blogs to
> news, videos, case studies, tutorials and more. Take a look and join the
> conversation now. http://goparallel.sourceforge.net/