* bug#41829: ERT commands that aren't in the info
@ 2020-06-12 16:19 Douglas Lewan
2020-08-13 20:22 ` Stefan Kangas
0 siblings, 1 reply; 4+ messages in thread
From: Douglas Lewan @ 2020-06-12 16:19 UTC (permalink / raw)
To: 41829
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 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've verified this looking through the texinfo source for versions 24.5
and 26.3.
I'd be happy to work on text for this if that's appropriate.
--
,Doug
d.lewan2000@gmail.com
(908) 720 7908
If this is what winning looks like, I'd hate to see what losing is.
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#41829: ERT commands that aren't in the info
2020-06-12 16:19 bug#41829: ERT commands that aren't in the info Douglas Lewan
@ 2020-08-13 20:22 ` Stefan Kangas
2020-10-18 1:39 ` Stefan Kangas
2021-09-25 15:09 ` Stefan Kangas
0 siblings, 2 replies; 4+ messages in thread
From: Stefan Kangas @ 2020-08-13 20:22 UTC (permalink / raw)
To: Douglas Lewan; +Cc: 41829
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
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#41829: ERT commands that aren't in the info
2020-08-13 20:22 ` Stefan Kangas
@ 2020-10-18 1:39 ` Stefan Kangas
2021-09-25 15:09 ` Stefan Kangas
1 sibling, 0 replies; 4+ messages in thread
From: Stefan Kangas @ 2020-10-18 1:39 UTC (permalink / raw)
To: Douglas Lewan; +Cc: 41829
Stefan Kangas <stefan@marxist.se> writes:
>> I'd be happy to work on text for this if that's appropriate.
>
> That would be both welcome and useful, thank you.
That was 9 weeks ago, any updates here?
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#41829: ERT commands that aren't in the info
2020-08-13 20:22 ` Stefan Kangas
2020-10-18 1:39 ` Stefan Kangas
@ 2021-09-25 15:09 ` Stefan Kangas
1 sibling, 0 replies; 4+ messages in thread
From: Stefan Kangas @ 2021-09-25 15:09 UTC (permalink / raw)
To: Douglas Lewan; +Cc: 41829
tags 41829 fixed
close 41829 28.1
thanks
Stefan Kangas <stefan@marxist.se> writes:
> 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.
[...]
>> I'd be happy to work on text for this if that's appropriate.
>
> That would be both welcome and useful, thank you.
No further updates here within a year, so I've now made this change on
master (commit c7370f7334). This change will be part of Emacs 28.1.
Further tweaks, improvements and suggestions are welcome of course, but
for now I'm closing this bug report. Please reply to this email (use
"Reply to all" in your email client) and we can reopen the bug report if
needed, or you could just open a new bug.
Thanks again for the bug report!
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2021-09-25 15:09 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-06-12 16:19 bug#41829: ERT commands that aren't in the info Douglas Lewan
2020-08-13 20:22 ` Stefan Kangas
2020-10-18 1:39 ` Stefan Kangas
2021-09-25 15:09 ` Stefan Kangas
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).