GNU bug report logs - #15239
24.3.50; doc string of `fringe-styles'

Previous Next

Full log

View this message in rfc822 format

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 15239 <at> debbugs.gnu.org
Subject: bug#15239: 24.3.50; doc string of `fringe-styles'
Date: Fri, 07 Feb 2014 20:40:54 -0800

Drew Adams <drew.adams <at> oracle.com> writes:

> Unless I'm missing something, this doc string seems wrong on several
> counts.  And it is important because it is referred to by the doc of
> various fringe functions and variables, including `fringe-mode' itself.
>
> 1. The doc says that an alist element "has the form (NAME . WIDTH),
>    where NAME is a mnemonic fringe mode name (a symbol)".
>
>    Wrong.  NAME is *NOT* a symbol.  Presumably this wants instead to say
>    that NAME is a symbol name.  But why it would want to say that here
>    is not clear anyway.

Fixed on trunk.

> 2. The doc says that "WIDTH is one of the following:" followed by this:
>
>    "a cons cell (LEFT . RIGHT), where LEFT and RIGHT are respectively
>     the left and right fringe widths in pixels, or nil (meaning to
>     disable that fringe)."
>
>    Wrong again.  `nil' for LEFT or RIGHT does *NOT* mean to "disable
>    that fringe".  It means to "use the default width (8 pixels)", the
>    same thing `nil' means as a non-cons value for WIDTH, but in this
>    case only for "that fringe".

Fixed throughout the file.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.