GNU bug report logs - #18207
erc-truncate-buffer-on-save: misleading variable name and docstring

Previous Next

Full log

View this message in rfc822 format

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Ivan Shmakov <ivan <at> siamics.net>
Cc: 18207 <at> debbugs.gnu.org
Subject: bug#18207: erc-truncate-buffer-on-save: misleading variable name and docstring
Date: Sat, 14 Apr 2018 20:53:09 +0200

Ivan Shmakov <ivan <at> siamics.net> writes:

> 	The docstring for erc-truncate-buffer-on-save reads:
>
> Truncate any ERC (channel, query, server) buffer when it is saved.
>
> 	This is somewhat misleading, as there’re also erc-truncate
> 	module, and, in particular, – the erc-truncate-buffer function,
> 	which are used to truncate buffer /to a given size/ (see
> 	erc-max-buffer-size.)  On the contrary, this variable, when
> 	non-nil, forces the buffer to be /completely erased,/ as per the
> 	following lisp/erc/erc-log.el fragment:
>
>    434		      (if (and erc-truncate-buffer-on-save
>    435			       (called-interactively-p 'interactive))
>    436			  (progn
>    437			    (let ((inhibit-read-only t)) (erase-buffer))
>    438			    (move-marker erc-last-saved-position (point-max))
>    439			    (erc-display-prompt))
>
> 	I believe that this behavior should be made clear in the
> 	documentation, like:
>
> Erase ERC (channel, query, server) buffers when one is saved.

I've now made a similar change to Emacs 27.1.

-- 
(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.