From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Fri, 11 Sep 2020 12:26:15 +0000 (+0200)
Subject: Improve diff-no-select doc string
X-Git-Tag: emacs-28.0.90~6126
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=8d9133c6027512738f313d3342b7b6e9dc68ddd0;p=emacs.git

Improve diff-no-select doc string

* lisp/vc/diff.el (diff-no-select): Improve the doc string somewhat.
---

diff --git a/lisp/vc/diff.el b/lisp/vc/diff.el
index 2ed8573c07d..edb231cf605 100644
--- a/lisp/vc/diff.el
+++ b/lisp/vc/diff.el
@@ -146,12 +146,15 @@ Possible values are:
 (defun diff-no-select (old new &optional switches no-async buf)
   ;; Noninteractive helper for creating and reverting diff buffers
   "Compare the OLD and NEW file/buffer.
+If the optional SWITCHES is nil, the switches specified in the
+variable ‘diff-switches’ are passed to the diff command,
+otherwise SWITCHES is used.
 
-If BUF is nil, the \"*Diff*\" buffer will be used as the diff
-buffer.  If non-nil, BUF will be used as the diff buffer.  The
-buffer used will be returned by this value.
+If NO-ASYNC is non-nil, call diff synchronously.
 
-See `diff' for the meaning of the SWITCHES and NO-ASYNC arguments."
+By default, this function creates the diff in the \"*Diff*\"
+buffer.  If BUF is non-nil, BUF is used instead.  This function
+returns the buffer used."
   (unless (bufferp new) (setq new (expand-file-name new)))
   (unless (bufferp old) (setq old (expand-file-name old)))
   (or switches (setq switches diff-switches)) ; If not specified, use default.