GNU bug report logs - #77311
Minor documentation fix (`use-package')

Previous Next

Full log

View this message in rfc822 format

From: Dominik Schrempf <dominik.schrempf <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 77311 <at> debbugs.gnu.org
Subject: bug#77311: Minor documentation fix (`use-package')
Date: Sat, 29 Mar 2025 14:54:39 +0100

[Message part 1 (text/plain, inline)]

Hi,

thanks for your comments.

Please find attached the updated patch. I still changed the tense used
in the documentation of `:commands'.

Best,
Dominik

[0001-Fix-minor-issues-in-documentation-of-use-package.patch (text/x-patch, attachment)]

[Message part 3 (text/plain, inline)]

Eli Zaretskii <eliz <at> gnu.org> writes:

>> From: Dominik Schrempf <dominik.schrempf <at> gmail.com>
>> Date: Thu, 27 Mar 2025 16:01:33 +0100
>>
>> I attach a suggested minor patch of the documentation of `use-package'.
>
> Thanks, see some comments below.
>
>> --- a/lisp/use-package/use-package-core.el
>> +++ b/lisp/use-package/use-package-core.el
>> @@ -1849,11 +1849,11 @@ Usage:
>>  :magic-fallback  Form to be added to `magic-fallback-mode-alist'.
>>  :interpreter     Form to be added to `interpreter-mode-alist'.
>>
>> -:commands        Define autoloads for commands that will be defined by the
>> +:commands        Define autoloads for interactive commands defined by the
>>                   package.  This is useful if the package is being lazily
>> -                 loaded, and you wish to conditionally call functions in your
>> -                 `:init' block that are defined in the package.
>> -:autoload        Similar to :commands, but it for no-interactive one.
>> +                 loaded, and you wish to conditionally call functions in
>> +                 your `:init' block that are defined in the package.
>> +:autoload        Similar to `:commands', but used for non-interactive commands.
>>  :hook            Specify hook(s) to attach this package to.
>>
>>  :bind            Bind keys, and define autoloads for the bound commands.
>
> A command is always interactive.  So saying "interactive commands" is
> a kind-of tautology, and "non-interactive commands" is something that
> doesn't exist in Emacs.
>
> My suggestion is to leave the description of :commands unchanged, and
> modify :autoload to say that its for non-interactive functions.

Previous Next

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