GNU bug report logs - #41829
ERT commands that aren't in the info

Previous Next

Full log

Message #8 received at 41829 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: Douglas Lewan <d.lewan2000 <at> gmail.com>
Cc: 41829 <at> debbugs.gnu.org
Subject: Re: bug#41829: ERT commands that aren't in the info
Date: Thu, 13 Aug 2020 13:22:44 -0700

Hi Douglas,

Sorry for the late reply here.

Douglas Lewan <d.lewan2000 <at> gmail.com> writes:

> The following ERT commands do not appear in the info doumentation for ERT and
> should.
>
> Most would be appropriate in the section "Running test interactively". Those
> commands with associated keys are mentioned in ert-results-mode, but, still,
> should appear in the info.
> The command M-x ert-delete-all-tests is especially useful for creating a clean
> slate, but it is not mentioned at all.
>
> ert-delete-all-tests
> ert-delete-test (key D)
> ert-describe-test
> ert-find-test-other-window
> ert-results-describe-test-at-point (key h)
> ert-results-jump-between-summary-and-result (key j)
> ert-results-next-test (key n)
> ert-results-pop-to-timings (key T)
> ert-results-previous-test (key p)
> ert-results-rerun-all-tests (key R)
> ert-run-tests-interactively

It would be useful to document them in the Info documentation, indeed.
Probably no one found the time to do it yet, is all.

> It would also be worth mentioning these commands defined elsewhere but with an
> interactive UI in ert-results-mode
>
> describe-mode (key ?)
> revert-buffer (key g)
> quit-window (key q)

I'm not sure we need to document these however, since they are generic
(from `special-mode') and available all over.  Presumably they would
already be familiar to almost all ELisp developers (who would the target
group of the ERT Info manual).

> I'd be happy to work on text for this if that's appropriate.

That would be both welcome and useful, thank you.

Best regards,
Stefan Kangas

Previous Next

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