* bug#15375: 24.3.50; Elisp manual: mention what units are used for window margin functions
@ 2013-09-13 22:17 Drew Adams
2013-09-14 9:27 ` Eli Zaretskii
0 siblings, 1 reply; 6+ messages in thread
From: Drew Adams @ 2013-09-13 22:17 UTC (permalink / raw)
To: 15375
(elisp) `Display Margins` talks a lot about window margins, but AFAICT
it never once says which units are used for the functions and variables
described there. I'm guessing the unit is `frame-char-width', but Emacs
should tell us explicitly here.
Moreover, we don't even tell users what a nil value means, as opposed
to a whole number.
For example, right now, `M-: (window-margins)' returns `(nil)' for me,
which corresponds to both LEFT and RIGHT being nil. What does a nil
value mean for each of these?
In GNU Emacs 24.3.50.1 (i686-pc-mingw32)
of 2013-08-31 on ODIEONE
Bzr revision: 114088 rgm@gnu.org-20130901021232-sazo0qla2qgcko95
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
`configure --prefix=/c/Devel/emacs/binary --enable-checking=yes,glyphs
'CFLAGS=-O0 -g3' LDFLAGS=-Lc:/Devel/emacs/lib
CPPFLAGS=-Ic:/Devel/emacs/include'
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#15375: 24.3.50; Elisp manual: mention what units are used for window margin functions
2013-09-13 22:17 bug#15375: 24.3.50; Elisp manual: mention what units are used for window margin functions Drew Adams
@ 2013-09-14 9:27 ` Eli Zaretskii
0 siblings, 0 replies; 6+ messages in thread
From: Eli Zaretskii @ 2013-09-14 9:27 UTC (permalink / raw)
To: Drew Adams; +Cc: 15375
> Date: Fri, 13 Sep 2013 15:17:31 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
>
> (elisp) `Display Margins` talks a lot about window margins, but AFAICT
> it never once says which units are used for the functions and variables
> described there. I'm guessing the unit is `frame-char-width', but Emacs
> should tell us explicitly here.
The units are character cells (a.k.a. "columns").
I fixed this in trunk revision 114279.
> Moreover, we don't even tell users what a nil value means, as opposed
> to a whole number.
>
> For example, right now, `M-: (window-margins)' returns `(nil)' for me,
> which corresponds to both LEFT and RIGHT being nil. What does a nil
> value mean for each of these?
Fixed that as well.
Thanks.
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#15375: 24.3.50; Elisp manual: mention what units are used for window margin functions
[not found] ` <<8361u3hhwn.fsf@gnu.org>
@ 2013-09-14 15:18 ` Drew Adams
2013-09-14 15:29 ` Eli Zaretskii
0 siblings, 1 reply; 6+ messages in thread
From: Drew Adams @ 2013-09-14 15:18 UTC (permalink / raw)
To: Eli Zaretskii, Drew Adams; +Cc: 15375
> > (elisp) `Display Margins` talks a lot about window margins, but AFAICT
> > it never once says which units are used for the functions and variables
> > described there. I'm guessing the unit is `frame-char-width', but Emacs
> > should tell us explicitly here.
>
> The units are character cells (a.k.a. "columns").
>
> I fixed this in trunk revision 114279.
>
> > Moreover, we don't even tell users what a nil value means, as opposed
> > to a whole number.
> >
> > For example, right now, `M-: (window-margins)' returns `(nil)' for me,
> > which corresponds to both LEFT and RIGHT being nil. What does a nil
> > value mean for each of these?
>
> Fixed that as well.
Thanks. Do you want me to close the bug, or do you want to?
(Dunno whether you wanted to keep it open for some reason.)
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#15375: 24.3.50; Elisp manual: mention what units are used for window margin functions
2013-09-14 15:18 ` Drew Adams
@ 2013-09-14 15:29 ` Eli Zaretskii
0 siblings, 0 replies; 6+ messages in thread
From: Eli Zaretskii @ 2013-09-14 15:29 UTC (permalink / raw)
To: Drew Adams; +Cc: 15375
> Date: Sat, 14 Sep 2013 08:18:38 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
> Cc: 15375@debbugs.gnu.org
>
> > > (elisp) `Display Margins` talks a lot about window margins, but AFAICT
> > > it never once says which units are used for the functions and variables
> > > described there. I'm guessing the unit is `frame-char-width', but Emacs
> > > should tell us explicitly here.
> >
> > The units are character cells (a.k.a. "columns").
> >
> > I fixed this in trunk revision 114279.
> >
> > > Moreover, we don't even tell users what a nil value means, as opposed
> > > to a whole number.
> > >
> > > For example, right now, `M-: (window-margins)' returns `(nil)' for me,
> > > which corresponds to both LEFT and RIGHT being nil. What does a nil
> > > value mean for each of these?
> >
> > Fixed that as well.
>
> Thanks. Do you want me to close the bug, or do you want to?
> (Dunno whether you wanted to keep it open for some reason.)
I left it open to allow you to review the changes. You can do that
either by pointing your browser at
http://bzr.savannah.gnu.org/lh/emacs/trunk/annotate/head:/doc/lispref/display.texi
and going down to line 4160, or by waiting for the next binary
snapshot of the trunk.
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#15375: 24.3.50; Elisp manual: mention what units are used for window margin functions
[not found] ` <<83ob7vfmlb.fsf@gnu.org>
@ 2013-09-14 16:26 ` Drew Adams
2013-09-14 16:33 ` Eli Zaretskii
0 siblings, 1 reply; 6+ messages in thread
From: Drew Adams @ 2013-09-14 16:26 UTC (permalink / raw)
To: Eli Zaretskii, Drew Adams; +Cc: 15375
> I left it open to allow you to review the changes. You can do that
> either by pointing your browser at
> http://bzr.savannah.gnu.org/lh/emacs/trunk/annotate/head:/doc/lispref/displa
> y.texi and going down to line 4160, or by waiting for the next binary
> snapshot of the trunk.
Thanks, and thanks for that URL & line #.
Looks good, but I have these minor suggestions, if you have the time:
1. Move the "(a.k.a.@: ``column'')" to the first occurrence of "character
cell". I, for one, did not know the latter term, and wondered about it
until I got to that aka.
2. You can remove this part, as it is implied: "; if none of the two margins
exist, the function returns @code{(nil)}." (It does not hurt, but in that
case please change "none" to "neither", to be clearer.)
3. You should add a comma before "and" in "The argument @var{left} controls
the left margin and @var{right} controls the right margin (default @code{0})."
,
Alternatively, you can use ";" instead of ", and", or split it into two
sentences.
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#15375: 24.3.50; Elisp manual: mention what units are used for window margin functions
2013-09-14 16:26 ` Drew Adams
@ 2013-09-14 16:33 ` Eli Zaretskii
0 siblings, 0 replies; 6+ messages in thread
From: Eli Zaretskii @ 2013-09-14 16:33 UTC (permalink / raw)
To: Drew Adams; +Cc: 15375-done
> Date: Sat, 14 Sep 2013 09:26:42 -0700 (PDT)
> From: Drew Adams <drew.adams@oracle.com>
> Cc: 15375@debbugs.gnu.org
>
> 1. Move the "(a.k.a.@: ``column'')" to the first occurrence of "character
> cell". I, for one, did not know the latter term, and wondered about it
> until I got to that aka.
>
> 2. You can remove this part, as it is implied: "; if none of the two margins
> exist, the function returns @code{(nil)}." (It does not hurt, but in that
> case please change "none" to "neither", to be clearer.)
>
> 3. You should add a comma before "and" in "The argument @var{left} controls
> the left margin and @var{right} controls the right margin (default @code{0})."
> ,
> Alternatively, you can use ";" instead of ", and", or split it into two
> sentences.
Done.
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2013-09-14 16:33 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-09-13 22:17 bug#15375: 24.3.50; Elisp manual: mention what units are used for window margin functions Drew Adams
2013-09-14 9:27 ` Eli Zaretskii
[not found] <<eaf7fceb-d02d-4cd9-9b52-e815d4c47926@default>
[not found] ` <<8361u3hhwn.fsf@gnu.org>
2013-09-14 15:18 ` Drew Adams
2013-09-14 15:29 ` Eli Zaretskii
[not found] <<56620f72-f813-4a5b-b6bc-3b543ebb8e50@default>
[not found] ` <<83ob7vfmlb.fsf@gnu.org>
2013-09-14 16:26 ` Drew Adams
2013-09-14 16:33 ` Eli Zaretskii
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).