bug-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: find-file and friends doc string improvements


From: Richard Stallman
Subject: Re: find-file and friends doc string improvements
Date: Sat, 10 Apr 2004 22:35:54 -0400

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.




reply via email to

[Prev in Thread] Current Thread [Next in Thread]