bug-texinfo
[Top][All Lists]
Advanced

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

Re: texinfo documentation? bug


From: Gavin Smith
Subject: Re: texinfo documentation? bug
Date: Wed, 19 Nov 2014 19:31:43 +0000

On Sun, Nov 16, 2014 at 11:40 PM, Karl Berry <address@hidden> wrote:
> I know it seems weird, but otherwise there is no explanation for the
> example as a whole being indented.  I don't remember, but I may have
> added the aside precisely because someone wondered about that (or maybe
> it was there all along, I dunno).  Anyway, I don't see a good way to
> write the example without it, because the whole point is to show how to
> not-indent a first line after an @example and the example as a whole
> wouldn't come out right without being set off somehow.  I suppose I
> could add ", thus this example's indentation as a whole" to the aside
> but I suspect that would just make things worse.  Do you see a good
> revision to make?

I see what you mean, so it needs to explain why the example is
indented despite the presence of @noindent. Although "@display" and
"@end display" don't actually appear in the example you might imagine
that they are if you are not thinking too clearly. It depends how you
interpret "This whole example is between" - whether the things it is
between are part of the example, or outside of the example.

It might be better not to include the explanation itself within the
indented example, but put it after. Something like the following,
maybe with less clumsy wording:

Index: texinfo.texi
===================================================================
--- texinfo.texi        (revision 5923)
+++ texinfo.texi        (working copy)
@@ -8990,8 +8990,7 @@
 @@noindent
 This line is not indented.  As you can see, the
 beginning of the line is fully flush left with the line
-that follows after it.  (This whole example is between
-@@address@hidden@@@@address@hidden and @@address@hidden@@@@end address@hidden)
+that follows after it.
 @end group
 @end example

@@ -9006,11 +9005,14 @@
 @noindent
 This line is not indented.  As you can see, the
 beginning of the line is fully flush left with the line
-that follows after it.  (This whole example is between
address@hidden@@display} and @code{@@end display}.)
+that follows after it.

 @end display

address@hidden
+(The example above is indented as a whole in this manual to mark it as
+an example.)
+
 To adjust the number of blank lines properly in the Info file output,
 remember that the line containing @code{@@noindent} does not generate a
 blank line, and neither does the @code{@@end example} line.



reply via email to

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