GNU bug report logs - #77142
[PATCH] ; * lisp/emacs-lisp/igc.el: checkdox fixes for interactive functions

Previous Next

Full log

View this message in rfc822 format

From: Jeremy Bryant <jb <at> jeremybryant.net>
To: Pip Cet <pipcet <at> protonmail.com>
Cc: gerd.moellmann <at> gmail.com, Eli Zaretskii <eliz <at> gnu.org>, eller.helmut <at> gmail.com, 77142 <at> debbugs.gnu.org
Subject: bug#77142: [PATCH] ; * lisp/emacs-lisp/igc.el: checkdox fixes for interactive functions
Date: Tue, 08 Apr 2025 22:12:51 +0100

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

Pip Cet <pipcet <at> protonmail.com> writes:

> "Jeremy Bryant" <jb <at> jeremybryant.net> writes:
>
>> Revised patch attached.

New partially revised patch attached with comments below.

> There are some differences between the docstrings for igc-stats and
> igc-roots. I think the igc-roots version is fine, and the igc-stats
> docstrings should be adjusted accordingly.

What do you mean?  Is it igc-roots-stats?  If so, what changes?

>>  (defun igc-display-diff ()
>> +  "Display the difference between IGC snapshots A-B.
>> +Used for debugging."
>
> I prefer "A and B", because we already spell out that we're calculating
> the difference. As in the docstring for igc-roots-display-diff, I'd also
> omit the "Used for debugging."

OK, done.

>
>>    (interactive)
>>    (setq igc--display-mode 'diff)
>>    (igc-stats))
>>
>>  (defun igc-display-a ()
>> +  "Display IGC stats snapshot A from igc--roots."
>
> I'm not sure about the "from igc--roots" part. ... "in igc-stats-mode"
> would work, but we can also omit it entirely.

OK, revision attached.

[0001-lisp-emacs-lisp-igc.el-checkdox-fixes-for-interactiv.patch (text/x-diff, attachment)]

Previous Next

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