all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* bug#57815: 29.0.50; loaddefs-generate docstring: DIR vs. DIRS
@ 2022-09-15  2:55 Michael Heerdegen
  2022-09-15  6:18 ` Eli Zaretskii
  0 siblings, 1 reply; 3+ messages in thread
From: Michael Heerdegen @ 2022-09-15  2:55 UTC (permalink / raw)
  To: 57815


Hello,

the first arg of loaddefs-generate has the name DIR but the first
sentence names it DIRS.

While that argument can be a dir or a list of dirs, this first sentence
breaks our rules.

Would it be worth to name the argument "DIR-OR-DIRS" for discoverability
- or should the docstring just say

"Generate loaddefs files for Lisp files in DIR.
DIR can be either a single directory or a list of directories.
[...]" ?

TIA,

Michael.


In GNU Emacs 29.0.50 (build 7, x86_64-pc-linux-gnu, X toolkit, cairo
 version 1.16.0, Xaw scroll bars) of 2022-09-14 built on drachen
Repository revision: 0dfe8c6023564b4ea86424c790ad0b4925110e1a
Repository branch: master
Windowing system distributor 'The X.Org Foundation', version 11.0.12011000
System Description: Debian GNU/Linux 11 (bullseye)

Configured using:
 'configure --with-x-toolkit=lucid'






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

* bug#57815: 29.0.50; loaddefs-generate docstring: DIR vs. DIRS
  2022-09-15  2:55 bug#57815: 29.0.50; loaddefs-generate docstring: DIR vs. DIRS Michael Heerdegen
@ 2022-09-15  6:18 ` Eli Zaretskii
  2022-09-15  8:31   ` Michael Heerdegen
  0 siblings, 1 reply; 3+ messages in thread
From: Eli Zaretskii @ 2022-09-15  6:18 UTC (permalink / raw)
  To: Michael Heerdegen; +Cc: 57815

> From: Michael Heerdegen <michael_heerdegen@web.de>
> Date: Thu, 15 Sep 2022 04:55:13 +0200
> 
> the first arg of loaddefs-generate has the name DIR but the first
> sentence names it DIRS.
> 
> While that argument can be a dir or a list of dirs, this first sentence
> breaks our rules.

Yes, should be fixed now.

> Would it be worth to name the argument "DIR-OR-DIRS" for discoverability
> - or should the docstring just say
> 
> "Generate loaddefs files for Lisp files in DIR.
> DIR can be either a single directory or a list of directories.
> [...]" ?

I made it say

  Generate loaddefs files for Lisp files in one or more directories given by DIR.






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

* bug#57815: 29.0.50; loaddefs-generate docstring: DIR vs. DIRS
  2022-09-15  6:18 ` Eli Zaretskii
@ 2022-09-15  8:31   ` Michael Heerdegen
  0 siblings, 0 replies; 3+ messages in thread
From: Michael Heerdegen @ 2022-09-15  8:31 UTC (permalink / raw)
  To: Eli Zaretskii; +Cc: 57815-done

Eli Zaretskii <eliz@gnu.org> writes:

> I made it say
>
>   Generate loaddefs files for Lisp files in one or more directories
> given by DIR.

Perfect, thanks.  Closing.

Michael.





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

end of thread, other threads:[~2022-09-15  8:31 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-09-15  2:55 bug#57815: 29.0.50; loaddefs-generate docstring: DIR vs. DIRS Michael Heerdegen
2022-09-15  6:18 ` Eli Zaretskii
2022-09-15  8:31   ` Michael Heerdegen

Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.