unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#52339: 26.3; Doc of functions that accept file-name args: say whether absolute
@ 2021-12-06 22:26 Drew Adams
  2021-12-07 13:01 ` Eli Zaretskii
  0 siblings, 1 reply; 2+ messages in thread
From: Drew Adams @ 2021-12-06 22:26 UTC (permalink / raw)
  To: 52339

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.

In GNU Emacs 26.3 (build 1, x86_64-w64-mingw32)
 of 2019-08-29
Repository revision: 96dd0196c28bc36779584e47fffcca433c9309cd
Windowing system distributor `Microsoft Corp.', version 10.0.19042
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''






^ permalink raw reply	[flat|nested] 2+ messages in thread

* bug#52339: 26.3; Doc of functions that accept file-name args: say whether absolute
  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
  0 siblings, 0 replies; 2+ messages in thread
From: Eli Zaretskii @ 2021-12-07 13:01 UTC (permalink / raw)
  To: Drew Adams; +Cc: 52339-done

> 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.





^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2021-12-07 13:01 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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

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).