bug#41829: ERT commands that aren't in the info

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

bug#41829: ERT commands that aren't in the info

Douglas Lewan-2
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
[hidden email]
(908) 720 7908

If this is what winning looks like, I'd hate to see what losing is.




Reply | Threaded
Open this post in threaded view
|

bug#41829: ERT commands that aren't in the info

Stefan Kangas
Hi Douglas,

Sorry for the late reply here.

Douglas Lewan <[hidden email]> 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 | Threaded
Open this post in threaded view
|

bug#41829: ERT commands that aren't in the info

Stefan Kangas
Stefan Kangas <[hidden email]> 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?