--- Begin Message ---
Subject: |
25.0.50; doc string of `recenter-last-op` |
Date: |
Fri, 24 Apr 2015 10:16:11 -0700 (PDT) |
The doc string says that these are the possible values:
"`top', `middle', `bottom', integer or float numbers."
It should also mention `nil', say what `nil' means, and perhaps even say
that `nil' is the default value.
A user reading things like the binding of this variable to nil in
`perform-replace' is not helped by consulting the variable's doc.
In GNU Emacs 25.0.50.1 (i686-pc-mingw32)
of 2014-10-20 on LEG570
Bzr revision: 118168 address@hidden
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
`configure --enable-checking=yes,glyphs CPPFLAGS=-DGLYPH_DEBUG=1'
--- End Message ---
--- Begin Message ---
Subject: |
Re: bug#20419: 25.0.50; doc string of `recenter-last-op` |
Date: |
Sat, 25 Apr 2015 17:55:27 +0300 |
> Date: Sat, 25 Apr 2015 07:29:20 -0700 (PDT)
> From: Drew Adams <address@hidden>
> Cc: address@hidden
>
> > > The doc string says that these are the possible values:
> > > "`top', `middle', `bottom', integer or float numbers."
> > > It should also mention `nil', say what `nil' means, and
> > > perhaps even say that `nil' is the default value.
> >
> > How do you see that nil has any meaning whatsoever?
>
> `nil' means that the next `recenter-top-bottom' starts with
> the first element of `recenter-positions'.
Yuck! Why not set it to the first member of recenter-positions to
begin with?
FWIW, I consider this, including the exposure of this variable as some
kind of knob for other Lisp packages, bad style. You should be
demanding cleaning this up instead of documenting it.
Fixed under protest.
--- End Message ---