GNU bug report logs - #57815
29.0.50; loaddefs-generate docstring: DIR vs. DIRS

Previous Next

Full log

View this message in rfc822 format

From: Eli Zaretskii <eliz <at> gnu.org>
To: Michael Heerdegen <michael_heerdegen <at> web.de>
Cc: 57815 <at> debbugs.gnu.org
Subject: bug#57815: 29.0.50; loaddefs-generate docstring: DIR vs. DIRS
Date: Thu, 15 Sep 2022 09:18:41 +0300

> From: Michael Heerdegen <michael_heerdegen <at> 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.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.