GNU bug report logs - #1434
Docstring for `toggle-read-only' shouldn't imply the buffer is file-visiting

Previous Next

Full log

View this message in rfc822 format

From: "Drew Adams" <drew.adams <at> oracle.com>
To: "'Juanma Barranquero'" <lekktu <at> gmail.com>,
        <1434 <at> debbugs.gnu.org>,
        "'Bug-Gnu-Emacs'" <bug-gnu-emacs <at> gnu.org>
Subject: bug#1434: Docstring for `toggle-read-only' shouldn't imply thebuffer is file-visiting
Date: Wed, 26 Nov 2008 10:08:30 -0800

> Most references to readonly-ness in files.el do talk about
> file-visiting buffers, which makes sense. However, `toggle-read-only'
> is useful for non-visiting buffers too, though the docstring seems to
> imply otherwise.
> 
> Docstring for `toggle-read-only' says:
> 
>  Change whether this buffer is visiting its file read-only.
>  With prefix argument ARG, make the buffer read-only if ARG is
>  positive, otherwise make it writable.  If visiting file read-only
>  and `view-read-only' is non-nil, enter view mode.

FWIW, I agree. When writing mode doc strings that describe some key bindings
using \\[...], for instance, I typically toggle read-only in *Help*, to adjust
line lengths there before correcting the source code.

Previous Next

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