From: Eli Zaretskii <eliz@gnu.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 52339-done@debbugs.gnu.org
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 [thread overview]
Message-ID: <83o85szhzt.fsf@gnu.org> (raw)
In-Reply-To: <SJ0PR10MB54885B3360D435DDAF956109F36D9@SJ0PR10MB5488.namprd10.prod.outlook.com> (message from Drew Adams on Mon, 6 Dec 2021 22:26:46 +0000)
> From: Drew Adams <drew.adams@oracle.com>
> 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.
prev parent reply other threads:[~2021-12-07 13:01 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-06 22:26 bug#52339: 26.3; Doc of functions that accept file-name args: say whether absolute Drew Adams
2021-12-07 13:01 ` Eli Zaretskii [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83o85szhzt.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=52339-done@debbugs.gnu.org \
--cc=drew.adams@oracle.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).