unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Kangas <stefan@marxist.se>
To: Douglas Lewan <d.lewan2000@gmail.com>
Cc: 41829@debbugs.gnu.org
Subject: bug#41829: ERT commands that aren't in the info
Date: Thu, 13 Aug 2020 13:22:44 -0700	[thread overview]
Message-ID: <CADwFkmmPNBqAMEavcCy9OdF9u1YT=0C++2O4tRr3Tj2wJueHnQ@mail.gmail.com> (raw)
In-Reply-To: <bcf11eca-004c-ae3c-7451-265d9ef8dbef@gmail.com> (Douglas Lewan's message of "Fri, 12 Jun 2020 12:19:45 -0400")

Hi Douglas,

Sorry for the late reply here.

Douglas Lewan <d.lewan2000@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





  reply	other threads:[~2020-08-13 20:22 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-12 16:19 bug#41829: ERT commands that aren't in the info Douglas Lewan
2020-08-13 20:22 ` Stefan Kangas [this message]
2020-10-18  1:39   ` Stefan Kangas
2021-09-25 15:09   ` Stefan Kangas

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='CADwFkmmPNBqAMEavcCy9OdF9u1YT=0C++2O4tRr3Tj2wJueHnQ@mail.gmail.com' \
    --to=stefan@marxist.se \
    --cc=41829@debbugs.gnu.org \
    --cc=d.lewan2000@gmail.com \
    /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).