From: Richard Stallman <rms@gnu.org>
Cc: gnu-emacs-bug@moderators.isc.org
Subject: Re: find-file and friends doc string improvements
Date: Sat, 10 Apr 2004 22:35:54 -0400 [thread overview]
Message-ID: <E1BCUp8-00070k-6W@fencepost.gnu.org> (raw)
In-Reply-To: <16503.7480.436692.391082@ihs.com> (message from Kevin Rodgers on Fri, 9 Apr 2004 16:01:28 -0600)
Some of those changes are good, but there are some problems.
If `find-file-visit-truename' is set, a buffer
! visiting the same file under a different name will be selected.
!
Please avoid the passive voice when writing documentation.
It makes text harder to read and sometimes causes vagueness.
! "Edit file FILENAME, in another window.
! May create a new window, or reuse an existing one.
! See the function `display-buffer'.
! Interactively, or if WILDCARDS is non-nil in a call from Lisp,
! expand wildcards (if any) and visit multiple files."
(interactive "FFind file in other window: \np")
(let ((value (find-file-noselect filename nil nil wildcards)))
(if (listp value)
--- 742,753 ----
(switch-to-buffer value))))
(defun find-file-other-window (filename &optional wildcards)
! "Edit file FILENAME as with `find-file', in another window.
! May create a new window, or reuse an existing one. See the function
! `display-buffer'.
!
! Interactively, or if WILDCARDS is non-nil in a call from Lisp, expand
! wildcards (if any) and visit multiple files."
The current text has line breaks that make it easier to read.
Filling the text to make longer lines would not be an improvement.
***************
*** 768,775 ****
(switch-to-buffer-other-frame value))))
(defun find-file-read-only (filename &optional wildcards)
! "Edit file FILENAME but don't allow changes.
! Like `find-file' but marks buffer as read-only.
Use \\[toggle-read-only] to permit editing."
(interactive "fFind file read-only: \np")
(find-file filename wildcards)
--- 774,781 ----
(switch-to-buffer-other-frame value))))
(defun find-file-read-only (filename &optional wildcards)
! "Edit file FILENAME as with `find-file', but don't allow changes.
! Marks buffer as read-only.
Use \\[toggle-read-only] to permit editing."
(interactive "fFind file read-only: \np")
(find-file filename wildcards)
***************
*** 777,784 ****
(current-buffer))
(defun find-file-read-only-other-window (filename &optional wildcards)
! "Edit file FILENAME in another window but don't allow changes.
! Like \\[find-file-other-window] but marks buffer as read-only.
Use \\[toggle-read-only] to permit editing."
(interactive "fFind file read-only other window: \np")
(find-file-other-window filename wildcards)
--- 783,790 ----
(current-buffer))
(defun find-file-read-only-other-window (filename &optional wildcards)
! "Edit file FILENAME as with `find-file-read-only', in another window.
! Like \\[find-file-other-window], but marks buffer as read-only.
Use \\[toggle-read-only] to permit editing."
(interactive "fFind file read-only other window: \np")
(find-file-other-window filename wildcards)
Those are good changes. The rest of the changes are also good.
If someone would like to install them, that would be good.
prev parent reply other threads:[~2004-04-11 2:35 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2004-04-09 22:01 find-file and friends doc string improvements Kevin Rodgers
2004-04-11 2:35 ` Richard Stallman [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=E1BCUp8-00070k-6W@fencepost.gnu.org \
--to=rms@gnu.org \
--cc=gnu-emacs-bug@moderators.isc.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).