Skip to content

Commit 38a4f05

Browse files
committed
re-instate docs for LearnTestAPI
1 parent e3c9b93 commit 38a4f05

File tree

1 file changed

+40
-40
lines changed

1 file changed

+40
-40
lines changed

docs/src/testing_an_implementation.md

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -2,56 +2,56 @@
22

33
Testing is provided by the LearnTestAPI.jl package.
44

5-
<!-- Testing is provided by the LearnTestAPI.jl package documented below. -->
5+
Testing is provided by the LearnTestAPI.jl package documented below.
66

7-
<!-- ## Quick start -->
7+
## Quick start
88

9-
<!-- ```@docs -->
10-
<!-- LearnTestAPI -->
11-
<!-- ``` -->
9+
```@docs
10+
LearnTestAPI
11+
```
1212

13-
<!-- !!! warning -->
13+
!!! warning
1414

15-
<!-- New releases of LearnTestAPI.jl may add tests to `@testapi`, and -->
16-
<!-- this may result in new failures in client package test suites, because -->
17-
<!-- of previously undetected broken contracts. Adding a test to `@testapi` -->
18-
<!-- is not considered a breaking change -->
19-
<!-- to LearnTestAPI, unless it supports a breaking change to LearnAPI.jl. -->
15+
New releases of LearnTestAPI.jl may add tests to `@testapi`, and
16+
this may result in new failures in client package test suites, because
17+
of previously undetected broken contracts. Adding a test to `@testapi`
18+
is not considered a breaking change
19+
to LearnTestAPI, unless it supports a breaking change to LearnAPI.jl.
2020

2121

22-
<!-- ## The @testapi macro -->
22+
## The @testapi macro
2323

24-
<!-- ```@docs -->
25-
<!-- LearnTestAPI.@testapi -->
26-
<!-- ``` -->
24+
```@docs
25+
LearnTestAPI.@testapi
26+
```
2727

28-
<!-- ## Learners for testing -->
28+
## Learners for testing
2929

30-
<!-- LearnTestAPI.jl provides some simple, tested, LearnAPI.jl implementations, which may be -->
31-
<!-- useful for testing learner wrappers and meta-algorithms. -->
30+
LearnTestAPI.jl provides some simple, tested, LearnAPI.jl implementations, which may be
31+
useful for testing learner wrappers and meta-algorithms.
3232

33-
<!-- ```@docs -->
34-
<!-- LearnTestAPI.Ridge -->
35-
<!-- LearnTestAPI.BabyRidge -->
36-
<!-- LearnTestAPI.ConstantClassifier -->
37-
<!-- LearnTestAPI.TruncatedSVD -->
38-
<!-- LearnTestAPI.Selector -->
39-
<!-- LearnTestAPI.FancySelector -->
40-
<!-- LearnTestAPI.NormalEstimator -->
41-
<!-- LearnTestAPI.Ensemble -->
42-
<!-- LearnTestAPI.StumpRegressor -->
43-
<!-- ``` -->
33+
```@docs
34+
LearnTestAPI.Ridge
35+
LearnTestAPI.BabyRidge
36+
LearnTestAPI.ConstantClassifier
37+
LearnTestAPI.TruncatedSVD
38+
LearnTestAPI.Selector
39+
LearnTestAPI.FancySelector
40+
LearnTestAPI.NormalEstimator
41+
LearnTestAPI.Ensemble
42+
LearnTestAPI.StumpRegressor
43+
```
4444

45-
<!-- ## Private methods -->
45+
## Private methods
4646

47-
<!-- For LearnTestAPI.jl developers only, and subject to breaking changes at any time: -->
47+
For LearnTestAPI.jl developers only, and subject to breaking changes at any time:
4848

49-
<!-- ```@docs -->
50-
<!-- LearnTestAPI.@logged_testset -->
51-
<!-- LearnTestAPI.@nearly -->
52-
<!-- LearnTestAPI.isnear -->
53-
<!-- LearnTestAPI.learner_get -->
54-
<!-- LearnTestAPI.model_get -->
55-
<!-- LearnTestAPI.verb -->
56-
<!-- LearnTestAPI.filter_out_verbosity -->
57-
<!-- ``` -->
49+
```@docs
50+
LearnTestAPI.@logged_testset
51+
LearnTestAPI.@nearly
52+
LearnTestAPI.isnear
53+
LearnTestAPI.learner_get
54+
LearnTestAPI.model_get
55+
LearnTestAPI.verb
56+
LearnTestAPI.filter_out_verbosity
57+
```

0 commit comments

Comments
 (0)