Re: master 32d1c1f: ; Grammar in simple.el doc strings and comments

Re: master 32d1c1f: ; Grammar in simple.el doc strings and comments

[Robert Pluim]

>>>>> On Sun, 17 Nov 2019 00:20:34 -0500 (EST), stepheng+savannah@gildea.com (Stephen Gildea) said:

    Stephen> branch: master
    Stephen> commit 32d1c1fc1f8d33df80c99cd147160b85583271f6
    Stephen> Author: Stephen Gildea <stepheng+emacs@gildea.com>
    Stephen> Commit: Stephen Gildea <stepheng+emacs@gildea.com>

    Stephen>     ; Grammar in simple.el doc strings and comments
    
    Stephen>     * lisp/simple.el: Improve the English grammar in some doc strings
    Stephen>     and comments.

I can be as pedantic as the next guy, but these changes do nothing to
improve the clarity or quality of the documentation. Please stop this
meaningless churn.

Robert

Re: master 32d1c1f: ; Grammar in simple.el doc strings and comments

[Paul Eggert]

[-- Attachment #1: Type: text/plain, Size: 324 bytes --]

On 11/17/19 10:38 AM, Robert Pluim wrote:
> these changes do nothing to
> improve the clarity or quality of the documentation.

To my eyes those patches actually improved doc quality slightly; I wouldn't have 
complained about them, at any rate.

I would go even further in one place, and did so by installing the attached.

[-- Attachment #2: 0001-lisp-simple.el-process-file-Clarify-doc-string.patch --]
[-- Type: text/x-patch, Size: 1508 bytes --]

From 0b47d731c08d0d5d4ba4a0c31f9be1152fd8c2c8 Mon Sep 17 00:00:00 2001
From: Paul Eggert <eggert@cs.ucla.edu>
Date: Sun, 17 Nov 2019 15:26:55 -0800
Subject: [PATCH] * lisp/simple.el (process-file): Clarify doc string.

---
 lisp/simple.el | 15 +++++++--------
 1 file changed, 7 insertions(+), 8 deletions(-)

diff --git a/lisp/simple.el b/lisp/simple.el
index 8229899f9a..c61ccd511c 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -4007,14 +4007,13 @@ process-file
 If PROGRAM is a remote file name, it should be processed
 by `file-local-name' before passing it to this function.
 
-File names in INFILE and BUFFER are handled normally, but file
-names in ARGS should be relative to `default-directory', as they
-are passed to the process verbatim.  (This is a difference from
-`call-process', which does not support file name handlers for INFILE
-and BUFFER.)
-
-Some file name handlers might not support all variants, for example
-they might behave as if DISPLAY was nil, regardless of the actual
+Handle file names in INFILE and BUFFER normally; this differs
+from `call-process', which does not support file name handlers
+for INFILE and BUFFER.  However, pass ARGS to the process
+verbatim without file name handling, as `call-process' does.
+
+Some file name handlers might not support all variants.  For
+example, they might treat DISPLAY as nil regardless of the actual
 value passed."
   (let ((fh (find-file-name-handler default-directory 'process-file))
         lc stderr-file)
-- 
2.17.1