GNU bug report logs -
#8652
24.0.50; incorrect indentation in (elisp) Special Properties
Previous Next
Reported by: "Drew Adams" <drew.adams <at> oracle.com>
Date: Wed, 11 May 2011 15:22:02 UTC
Severity: minor
Found in version 24.0.50
Done: Eli Zaretskii <eliz <at> gnu.org>
Bug is archived. No further changes may be made.
To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 8652 in the body.
You can then email your comments to 8652 AT debbugs.gnu.org in the normal way.
Toggle the display of automated, internal messages from the tracker.
Report forwarded
to
owner <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org:
bug#8652; Package
emacs.
(Wed, 11 May 2011 15:22:02 GMT)
Full text and
rfc822 format available.
Acknowledgement sent
to
"Drew Adams" <drew.adams <at> oracle.com>:
New bug report received and forwarded. Copy sent to
bug-gnu-emacs <at> gnu.org.
(Wed, 11 May 2011 15:22:02 GMT)
Full text and
rfc822 format available.
Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):
The reference sections, such as `--Variable:', should follow the same
indentation throughout the manual. In (elisp) Special Properties, the
two `--Variable:' sections are indented too far; they should be indented
to only column 1, as in the rest of the manual.
IOW, we should see:
-- Variable: inhibit-point-motion-hooks
not:
-- Variable: inhibit-point-motion-hooks
In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
of 2011-05-10 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.5) --no-opt --cflags
-Ic:/build/include'
Information forwarded
to
owner <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org:
bug#8652; Package
emacs.
(Wed, 11 May 2011 17:59:01 GMT)
Full text and
rfc822 format available.
Message #8 received at 8652 <at> debbugs.gnu.org (full text, mbox):
> From: "Drew Adams" <drew.adams <at> oracle.com>
> Date: Wed, 11 May 2011 08:21:33 -0700
>
> The reference sections, such as `--Variable:', should follow the same
> indentation throughout the manual.
Why? What bad things happen if they don't?
> In (elisp) Special Properties, the two `--Variable:' sections are
> indented too far; they should be indented to only column 1, as in
> the rest of the manual.
That's because they are pertinent to the `point-entered' and
`point-left' properties, and so are sub-items of their parent item.
Having them indented as you suggest would make them stand out of the
surrounding text, which IMO isn't right.
Information forwarded
to
owner <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org:
bug#8652; Package
emacs.
(Wed, 11 May 2011 18:23:01 GMT)
Full text and
rfc822 format available.
Message #11 received at 8652 <at> debbugs.gnu.org (full text, mbox):
> > The reference sections, such as `--Variable:', should
> > follow the same indentation throughout the manual.
>
> Why? What bad things happen if they don't?
>
> > In (elisp) Special Properties, the two `--Variable:' sections are
> > indented too far; they should be indented to only column 1, as in
> > the rest of the manual.
>
> That's because they are pertinent to the `point-entered' and
> `point-left' properties, and so are sub-items of their parent item.
> Having them indented as you suggest would make them stand out of the
> surrounding text, which IMO isn't right.
The description of `inhibit-point-motion-hooks' makes it clear what it pertains
to. This is so regardless of the indentation.
The description of `show-help-function' does not, however. It is not at all
clear - even with the extra indentation - what the scope of this variable's
effect is (the fact that it is somehow "pertinent [only] to the `point-entered'
and `point-left' properties"). The description suggests that it affects the
display of help strings _in general_. And nothing in the description says what
it does, in particular, for properties `point-entered' and `point-left'. Just
how is it pertinent only to them?
You will do whatever you want, of course. ;-) Just letting you know.
This is the _only_ place in the manual where the indentation is different.
Reply sent
to
Eli Zaretskii <eliz <at> gnu.org>:
You have taken responsibility.
(Sat, 14 May 2011 08:49:02 GMT)
Full text and
rfc822 format available.
Notification sent
to
"Drew Adams" <drew.adams <at> oracle.com>:
bug acknowledged by developer.
(Sat, 14 May 2011 08:49:02 GMT)
Full text and
rfc822 format available.
Message #16 received at 8652-done <at> debbugs.gnu.org (full text, mbox):
> From: "Drew Adams" <drew.adams <at> oracle.com>
> Cc: <8652 <at> debbugs.gnu.org>
> Date: Wed, 11 May 2011 11:22:41 -0700
>
> The description of `inhibit-point-motion-hooks' makes it clear what it pertains
> to. This is so regardless of the indentation.
>
> The description of `show-help-function' does not, however.
You are right. I moved the docs of both variables out of the
surrounding table, leaving a cross-reference to them in the table.
Message #17 received at 8652-done <at> debbugs.gnu.org (full text, mbox):
> You are right. I moved the docs of both variables out of the
> surrounding table, leaving a cross-reference to them in the table.
Thank you.
Message #18 received at 8652-done <at> debbugs.gnu.org (full text, mbox):
> From: "Drew Adams" <drew.adams <at> oracle.com>
> Cc: <8652-done <at> debbugs.gnu.org>
> Date: Sat, 14 May 2011 08:16:25 -0700
>
> > You are right. I moved the docs of both variables out of the
> > surrounding table, leaving a cross-reference to them in the table.
>
> Thank you.
You are welcome.
For the record: forensic analysis indicates that these two @defvars
were originally outside of the table, but when the table was updated
with the description of the `composition' property, they were
mistakenly included in the table.
Message #19 received at 8652-done <at> debbugs.gnu.org (full text, mbox):
> > > You are right. I moved the docs of both variables out of the
> > > surrounding table, leaving a cross-reference to them in the table.
> >
> > Thank you.
>
> You are welcome.
>
> For the record: forensic analysis indicates that these two @defvars
> were originally outside of the table, but when the table was updated
> with the description of the `composition' property, they were
> mistakenly included in the table.
FYI, I'm using Info in Emacs, so I don't see any table anyway. But I imagine
that a table becomes evident/visible in a printed manual or with some other ways
of viewing the text.
Message #20 received at 8652-done <at> debbugs.gnu.org (full text, mbox):
> From: "Drew Adams" <drew.adams <at> oracle.com>
> Cc: <8652-done <at> debbugs.gnu.org>
> Date: Sat, 14 May 2011 13:04:03 -0700
>
> FYI, I'm using Info in Emacs, so I don't see any table anyway. But I imagine
> that a table becomes evident/visible in a printed manual or with some other ways
> of viewing the text.
No, both Info and the printed manual show similar things, like this:
`composition'
This text property is used to display a sequence of characters as a
single glyph composed from components. But the value of the
property itself is completely internal to Emacs and should not be
manipulated directly by, for instance, `put-text-property'.
This is an Info "table": an item followed by its description, then
another item and its description, etc.
Message #21 received at 8652-done <at> debbugs.gnu.org (full text, mbox):
> > I'm using Info in Emacs, so I don't see any table anyway.
>
> No, both Info and the printed manual show similar things, like this:
>
> `composition'
> This text property is used to display a sequence of...
>
> This is an Info "table": an item followed by its description, then
> another item and its description, etc.
Ah, I see. Thanks; I wasn't aware of that terminology.
bug archived.
Request was from
Debbugs Internal Request <help-debbugs <at> gnu.org>
to
internal_control <at> debbugs.gnu.org.
(Sun, 12 Jun 2011 11:24:04 GMT)
Full text and
rfc822 format available.
This bug report was last modified 13 years and 307 days ago.
Previous Next
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.