unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Michael Heerdegen <michael_heerdegen@web.de>
To: 57815@debbugs.gnu.org
Subject: bug#57815: 29.0.50; loaddefs-generate docstring: DIR vs. DIRS
Date: Thu, 15 Sep 2022 04:55:13 +0200	[thread overview]
Message-ID: <87pmfxny7i.fsf@web.de> (raw)


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'






             reply	other threads:[~2022-09-15  2:55 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-15  2:55 Michael Heerdegen [this message]
2022-09-15  6:18 ` bug#57815: 29.0.50; loaddefs-generate docstring: DIR vs. DIRS Eli Zaretskii
2022-09-15  8:31   ` Michael Heerdegen

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=87pmfxny7i.fsf@web.de \
    --to=michael_heerdegen@web.de \
    --cc=57815@debbugs.gnu.org \
    /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).