From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Paul Eggert Newsgroups: gmane.emacs.devel Subject: Re: master 32d1c1f: ; Grammar in simple.el doc strings and comments Date: Sun, 17 Nov 2019 15:31:54 -0800 Organization: UCLA Computer Science Department Message-ID: <8072150e-4a69-0a11-53c6-e03ddbfd3c29@cs.ucla.edu> References: <20191117052033.32701.18626@vcs0.savannah.gnu.org> <20191117052035.30EC0209BF@vcs0.savannah.gnu.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="------------2ACE7ECEF5959BE37A0C6A7F" Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="160183"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.9.0 Cc: Stephen Gildea , emacs-devel@gnu.org To: Robert Pluim Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Nov 18 00:32:08 2019 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1iWU1X-000fVz-QJ for ged-emacs-devel@m.gmane.org; Mon, 18 Nov 2019 00:32:07 +0100 Original-Received: from localhost ([::1]:57090 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iWU1W-0004NF-88 for ged-emacs-devel@m.gmane.org; Sun, 17 Nov 2019 18:32:06 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:50804) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iWU1P-0004Mz-IC for emacs-devel@gnu.org; Sun, 17 Nov 2019 18:32:00 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iWU1O-0001xs-G3 for emacs-devel@gnu.org; Sun, 17 Nov 2019 18:31:59 -0500 Original-Received: from zimbra.cs.ucla.edu ([131.179.128.68]:59244) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1iWU1O-0001xH-8Q for emacs-devel@gnu.org; Sun, 17 Nov 2019 18:31:58 -0500 Original-Received: from localhost (localhost [127.0.0.1]) by zimbra.cs.ucla.edu (Postfix) with ESMTP id 39F3C1604F9; Sun, 17 Nov 2019 15:31:56 -0800 (PST) Original-Received: from zimbra.cs.ucla.edu ([127.0.0.1]) by localhost (zimbra.cs.ucla.edu [127.0.0.1]) (amavisd-new, port 10032) with ESMTP id ly6jmRx6UPIJ; Sun, 17 Nov 2019 15:31:55 -0800 (PST) Original-Received: from localhost (localhost [127.0.0.1]) by zimbra.cs.ucla.edu (Postfix) with ESMTP id 6A8DF1604FE; Sun, 17 Nov 2019 15:31:55 -0800 (PST) X-Virus-Scanned: amavisd-new at zimbra.cs.ucla.edu Original-Received: from zimbra.cs.ucla.edu ([127.0.0.1]) by localhost (zimbra.cs.ucla.edu [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id 26eYYhUIKGtV; Sun, 17 Nov 2019 15:31:55 -0800 (PST) Original-Received: from [192.168.1.9] (cpe-23-242-74-103.socal.res.rr.com [23.242.74.103]) by zimbra.cs.ucla.edu (Postfix) with ESMTPSA id 410D11604F9; Sun, 17 Nov 2019 15:31:55 -0800 (PST) In-Reply-To: Content-Language: en-US X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x [fuzzy] X-Received-From: 131.179.128.68 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:242339 Archived-At: This is a multi-part message in MIME format. --------------2ACE7ECEF5959BE37A0C6A7F Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit 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. --------------2ACE7ECEF5959BE37A0C6A7F Content-Type: text/x-patch; name="0001-lisp-simple.el-process-file-Clarify-doc-string.patch" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename*0="0001-lisp-simple.el-process-file-Clarify-doc-string.patch" >From 0b47d731c08d0d5d4ba4a0c31f9be1152fd8c2c8 Mon Sep 17 00:00:00 2001 From: Paul Eggert 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 --------------2ACE7ECEF5959BE37A0C6A7F--