From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#52339: 26.3; Doc of functions that accept file-name args: say whether absolute Date: Tue, 07 Dec 2021 15:01:26 +0200 Message-ID: <83o85szhzt.fsf@gnu.org> References: Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="23507"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 52339-done@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Dec 07 14:02:10 2021 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1mua6k-0005rj-LI for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 07 Dec 2021 14:02:10 +0100 Original-Received: from localhost ([::1]:37774 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mua6i-00022n-RL for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 07 Dec 2021 08:02:08 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:46678) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mua6c-00022X-8o for bug-gnu-emacs@gnu.org; Tue, 07 Dec 2021 08:02:02 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:53271) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mua6c-0005Gv-0L for bug-gnu-emacs@gnu.org; Tue, 07 Dec 2021 08:02:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mua6b-0004YO-Tu for bug-gnu-emacs@gnu.org; Tue, 07 Dec 2021 08:02:01 -0500 Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Tue, 07 Dec 2021 13:02:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 52339 X-GNU-PR-Package: emacs Mail-Followup-To: 52339@debbugs.gnu.org, eliz@gnu.org, drew.adams@oracle.com Original-Received: via spool by 52339-done@debbugs.gnu.org id=D52339.163888209417468 (code D ref 52339); Tue, 07 Dec 2021 13:02:01 +0000 Original-Received: (at 52339-done) by debbugs.gnu.org; 7 Dec 2021 13:01:34 +0000 Original-Received: from localhost ([127.0.0.1]:36583 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mua6A-0004Xg-Hv for submit@debbugs.gnu.org; Tue, 07 Dec 2021 08:01:34 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:45724) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mua68-0004XT-Ux for 52339-done@debbugs.gnu.org; Tue, 07 Dec 2021 08:01:33 -0500 Original-Received: from [2001:470:142:3::e] (port=38512 helo=fencepost.gnu.org) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mua61-00059x-QM; Tue, 07 Dec 2021 08:01:25 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=sgN2/mQgPf7tALbPUmrjs7h71XJ/RFwVfZIQje7wAUA=; b=HaZavLx4ikRz TOxMtDYBZTM5OSZYw3UARF0H2D5+JyIoZt2/zjYIFhy7rBirsPdX5yAUFQ61y7KfHjUztT2bOtl8D jW0wLY9aU96/uo/EfE25sFbH3uXCg/pTsZJRhJUfxg+sbM8v13pP/yklmECc+bwuELnX/3m4zV/wO ZdDHmKm6AbJNymMOCmALI9wdnHPszUVL6Mr8eO7rlutZ8WZZXlZaLXSTWBFzujBtCLAyRZctrYObm uWiUKykT/3JQz0HQKJDEftMkK35TMMFtwNUFVjeljQERVHwTHrEdNewPcIUCLW16zpAxk4GbdZiXv VoWFZC4kn7UPZeypWfKcMQ==; Original-Received: from [87.69.77.57] (port=3429 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mua61-0005MX-HI; Tue, 07 Dec 2021 08:01:25 -0500 In-Reply-To: (message from Drew Adams on Mon, 6 Dec 2021 22:26:46 +0000) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:221833 Archived-At: > From: Drew Adams > Date: Mon, 6 Dec 2021 22:26:46 +0000 > > This report is about the doc strings and the doc in the Elisp manual for > functions that accept file-name args. > > Please say, somewhere (preferably in each relevant node, since someone > might not start reading in node `Information about Files'), about the > file-name arg for a function documented in the node, whether the name > must be absolute or relative (e.g. to `default-directory') or can be > either. Similarly, for the doc strings of such functions. > > E.g. function `file-exists-p' itself expands its arg relative to > `default-directory', if the arg isn't an absolute name. This isn't > obvious. It should be obvious, because anything else would be a terrible bug, as should be clear if you consider the alternatives. Which is why Emacs does that in _all_ APIs that accept file names. Closing.