From debbugs-submit-bounces@debbugs.gnu.org Mon Sep 28 13:23:05 2015 Received: (at submit) by debbugs.gnu.org; 28 Sep 2015 17:23:06 +0000 Received: from localhost ([127.0.0.1]:46896 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1Zgc8n-0004Jk-Ix for submit@debbugs.gnu.org; Mon, 28 Sep 2015 13:23:05 -0400 Received: from eggs.gnu.org ([208.118.235.92]:54890) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1Zgc8l-0004Jc-FB for submit@debbugs.gnu.org; Mon, 28 Sep 2015 13:23:04 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Zgc8k-00010U-JO for submit@debbugs.gnu.org; Mon, 28 Sep 2015 13:23:03 -0400 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-0.5 required=5.0 tests=BAYES_05 autolearn=disabled version=3.3.2 Received: from lists.gnu.org ([2001:4830:134:3::11]:41495) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Zgc8k-00010O-GW for submit@debbugs.gnu.org; Mon, 28 Sep 2015 13:23:02 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:36660) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Zgc8j-0006BB-MX for bug-gnu-emacs@gnu.org; Mon, 28 Sep 2015 13:23:02 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Zgc8g-0000zC-Jb for bug-gnu-emacs@gnu.org; Mon, 28 Sep 2015 13:23:01 -0400 Received: from aserp1040.oracle.com ([141.146.126.69]:39197) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Zgc8g-0000y4-Dv for bug-gnu-emacs@gnu.org; Mon, 28 Sep 2015 13:22:58 -0400 Received: from userv0022.oracle.com (userv0022.oracle.com [156.151.31.74]) by aserp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id t8SHMudQ002366 (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Mon, 28 Sep 2015 17:22:56 GMT Received: from userv0122.oracle.com (userv0122.oracle.com [156.151.31.75]) by userv0022.oracle.com (8.13.8/8.13.8) with ESMTP id t8SHMtOo020660 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=FAIL) for ; Mon, 28 Sep 2015 17:22:56 GMT Received: from abhmp0005.oracle.com (abhmp0005.oracle.com [141.146.116.11]) by userv0122.oracle.com (8.13.8/8.13.8) with ESMTP id t8SHMt5l028853 for ; Mon, 28 Sep 2015 17:22:55 GMT MIME-Version: 1.0 Message-ID: <5d89275d-b8ad-4ced-b371-f40d24f08c21@default> Date: Mon, 28 Sep 2015 10:22:51 -0700 (PDT) From: Drew Adams To: bug-gnu-emacs@gnu.org Subject: 25.0.50; doc string of `load' X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9 (901082) [OL 12.0.6691.5000 (x86)] Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Source-IP: userv0022.oracle.com [156.151.31.74] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-Received-From: 2001:4830:134:3::11 X-Spam-Score: -4.0 (----) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -4.0 (----) Say that FILE is a string. In GNU Emacs 25.0.50.1 (i686-pc-mingw32) of 2015-09-23 Bzr revision: 325200ac1dcf5bed6918ea827d8a48d89487e083 Windowing system distributor `Microsoft Corp.', version 6.1.7601 Configured using: `configure --host=3Di686-pc-mingw32 --enable-checking=3Dyes,glyphs' From debbugs-submit-bounces@debbugs.gnu.org Tue Sep 29 01:22:45 2015 Received: (at 21581) by debbugs.gnu.org; 29 Sep 2015 05:22:46 +0000 Received: from localhost ([127.0.0.1]:47101 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1ZgnNF-0007BM-6w for submit@debbugs.gnu.org; Tue, 29 Sep 2015 01:22:45 -0400 Received: from mtaout28.012.net.il ([80.179.55.184]:59935) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1ZgnNC-0007BB-7x for 21581@debbugs.gnu.org; Tue, 29 Sep 2015 01:22:43 -0400 Received: from conversion-daemon.mtaout28.012.net.il by mtaout28.012.net.il (HyperSendmail v2007.08) id <0NVF00D00ATQKA00@mtaout28.012.net.il> for 21581@debbugs.gnu.org; Tue, 29 Sep 2015 08:22:18 +0300 (IDT) Received: from HOME-C4E4A596F7 ([84.94.185.246]) by mtaout28.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0NVF0084HAX6IE30@mtaout28.012.net.il>; Tue, 29 Sep 2015 08:22:18 +0300 (IDT) Date: Tue, 29 Sep 2015 08:22:53 +0300 From: Eli Zaretskii Subject: Re: bug#21581: 25.0.50; doc string of `load' In-reply-to: <5d89275d-b8ad-4ced-b371-f40d24f08c21@default> X-012-Sender: halo1@inter.net.il To: Drew Adams Message-id: <83oagldck2.fsf@gnu.org> MIME-version: 1.0 Content-type: text/plain; charset=utf-8 Content-transfer-encoding: 8BIT References: <5d89275d-b8ad-4ced-b371-f40d24f08c21@default> X-Spam-Score: 1.0 (+) X-Debbugs-Envelope-To: 21581 Cc: 21581@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list Reply-To: Eli Zaretskii List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 1.0 (+) > Date: Mon, 28 Sep 2015 10:22:51 -0700 (PDT) > From: Drew Adams > > Say that FILE is a string. load is a built-in function in ‘C source code’. (load FILE &optional NOERROR NOMESSAGE NOSUFFIX MUST-SUFFIX) Execute a file of Lisp code named FILE. Do you really mean we need to say explicitly that a file's name is a string in Emacs? What else can it be? From the ELisp manual: 24.8 File Names =============== Files are generally referred to by their names, in Emacs as elsewhere. File names in Emacs are represented as strings. The functions that operate on a file all expect a file name argument. I think this is so basic that we can always say "a file's name" and assume the reader must know it can only be a string. From debbugs-submit-bounces@debbugs.gnu.org Tue Sep 29 02:05:49 2015 Received: (at 21581) by debbugs.gnu.org; 29 Sep 2015 06:05:49 +0000 Received: from localhost ([127.0.0.1]:47113 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1Zgo2v-0008Ie-9Y for submit@debbugs.gnu.org; Tue, 29 Sep 2015 02:05:49 -0400 Received: from userp1040.oracle.com ([156.151.31.81]:50046) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1Zgo2s-0008IW-Nn for 21581@debbugs.gnu.org; Tue, 29 Sep 2015 02:05:47 -0400 Received: from userv0022.oracle.com (userv0022.oracle.com [156.151.31.74]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id t8T65j5P016332 (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Tue, 29 Sep 2015 06:05:45 GMT Received: from aserv0121.oracle.com (aserv0121.oracle.com [141.146.126.235]) by userv0022.oracle.com (8.13.8/8.13.8) with ESMTP id t8T65i1b011610 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=FAIL); Tue, 29 Sep 2015 06:05:45 GMT Received: from abhmp0007.oracle.com (abhmp0007.oracle.com [141.146.116.13]) by aserv0121.oracle.com (8.13.8/8.13.8) with ESMTP id t8T65inI021870; Tue, 29 Sep 2015 06:05:44 GMT MIME-Version: 1.0 Message-ID: <30d2221f-2d72-4985-91c9-4b1ff9447a45@default> Date: Mon, 28 Sep 2015 23:05:43 -0700 (PDT) From: Drew Adams To: Eli Zaretskii Subject: RE: bug#21581: 25.0.50; doc string of `load' References: <5d89275d-b8ad-4ced-b371-f40d24f08c21@default> <83oagldck2.fsf@gnu.org> In-Reply-To: <83oagldck2.fsf@gnu.org> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9 (901082) [OL 12.0.6691.5000 (x86)] Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Source-IP: userv0022.oracle.com [156.151.31.74] X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 21581 Cc: 21581@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.3 (--) > > Say that FILE is a string. >=20 > Do you really mean we need to say explicitly that a file's name is a > string in Emacs? That's my suggestion - do as you like. No, I'm not saying that we NEED to. I'm suggesting that it could help. > From the ELisp manual: > Files are generally referred to by their names, in Emacs as elsewhere. > File names in Emacs are represented as strings. The functions that > operate on a file all expect a file name argument. That's fine. But a user looking at the doc string doesn't see that. If you want to add a link to that manual node to the doc string, great. The very fact that that last sentence was explicitly added to the manual suggests that it is not obvious that file arguments are strings. If it were obvious then even that whole section about file names could perhaps be removed. (And again, that information is absent from the doc string.) > I think this is so basic that we can always say "a file's name" and > assume the reader must know it can only be a string. Yes, maybe. But I think it's also basic to specify the types of parameters in doc strings. (It could also help a bit to call the parameter FILENAME intead of FILE.) The doc strings of some functions (but yes, only a minority) already explicitly mention that the arg is a string: add-name-to-file autoload copy-file do-after-load-evaluation eval-after-load find-buffer-visiting get-file-buffer load-history-regexp make-symbolic-link rename-file (Consider also that some other, somewhat similar functions that load Lisp code allow a symbol parameter - `require', for instance. Granted, a feature is not a file. Still, I think it could help to make clear that FILE here is a string.) From debbugs-submit-bounces@debbugs.gnu.org Sat Apr 30 18:19:47 2016 Received: (at 21581) by debbugs.gnu.org; 30 Apr 2016 22:19:48 +0000 Received: from localhost ([127.0.0.1]:58687 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awdEp-00008W-Ox for submit@debbugs.gnu.org; Sat, 30 Apr 2016 18:19:47 -0400 Received: from hermes.netfonds.no ([80.91.224.195]:32876) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awdEo-00008O-4U for 21581@debbugs.gnu.org; Sat, 30 Apr 2016 18:19:46 -0400 Received: from cm-84.215.1.64.getinternet.no ([84.215.1.64] helo=mouse) by hermes.netfonds.no with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1awdEl-0007da-IT; Sun, 01 May 2016 00:19:45 +0200 From: Lars Ingebrigtsen To: Eli Zaretskii Subject: Re: bug#21581: 25.0.50; doc string of `load' References: <5d89275d-b8ad-4ced-b371-f40d24f08c21@default> <83oagldck2.fsf@gnu.org> Date: Sun, 01 May 2016 00:19:43 +0200 In-Reply-To: <83oagldck2.fsf@gnu.org> (Eli Zaretskii's message of "Tue, 29 Sep 2015 08:22:53 +0300") Message-ID: <87shy27n9c.fsf@gnus.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 21581 Cc: 21581@debbugs.gnu.org, Drew Adams X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 0.0 (/) Eli Zaretskii writes: > I think this is so basic that we can always say "a file's name" and > assume the reader must know it can only be a string. I agree. Closing. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no From debbugs-submit-bounces@debbugs.gnu.org Sat Apr 30 18:19:54 2016 Received: (at control) by debbugs.gnu.org; 30 Apr 2016 22:19:54 +0000 Received: from localhost ([127.0.0.1]:58690 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awdEv-00008o-W5 for submit@debbugs.gnu.org; Sat, 30 Apr 2016 18:19:54 -0400 Received: from hermes.netfonds.no ([80.91.224.195]:32884) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awdEu-00008h-OY for control@debbugs.gnu.org; Sat, 30 Apr 2016 18:19:53 -0400 Received: from cm-84.215.1.64.getinternet.no ([84.215.1.64] helo=mouse) by hermes.netfonds.no with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1awdEs-0007dm-JC for control@debbugs.gnu.org; Sun, 01 May 2016 00:19:52 +0200 Date: Sun, 01 May 2016 00:19:50 +0200 Message-Id: <87r3dm7n95.fsf@gnus.org> To: control@debbugs.gnu.org From: Lars Ingebrigtsen Subject: control message for bug #21581 X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 0.0 (/) tags 21581 wontfix close 21581 From unknown Tue Aug 19 10:05:17 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Sun, 29 May 2016 11:24:12 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator