Skip to content

Commit 86c4e20

Browse files
committed
Add more docs
1 parent 3b9a542 commit 86c4e20

File tree

7 files changed

+15
-1
lines changed

7 files changed

+15
-1
lines changed

docs/src/deps_compat.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ and to keep everything working in the case of breaking changes in Julia or your
77

88
For more details, see the [Pkg docs](https://julialang.github.io/Pkg.jl/v1/compatibility/).
99

10+
## [Test function](@id test_deps_compat)
11+
1012
```@docs
1113
Aqua.test_deps_compat
1214
```

docs/src/exports.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Undefined exports
22

3+
## [Test function](@id test_undefined_exports)
4+
35
```@docs
46
Aqua.test_undefined_exports
57
```

docs/src/project_extras.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ There are two different ways to specify test-only dependencies (see [the Pkg doc
99
This test checks checks that, in case you use both methods, the set of test-only dependencies
1010
is the same in both ways.
1111

12+
## [Test function](@id test_project_extras)
13+
1214
```@docs
1315
Aqua.test_project_extras
1416
```

docs/src/stale_deps.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Stale dependencies
22

3+
## [Test function](@id test_stale_deps)
4+
35
```@docs
46
Aqua.test_stale_deps
57
```

docs/src/test_all.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# [Test everything](@id test_all)
22

3+
This test runs most of the other tests in this module.
4+
The defaults should be fine for most packages.
5+
If you have a package that needs to customize the test, you can do so by providing appropriate keyword arguments to `Aqua.test_all()` (see below)
6+
37
```@docs
48
Aqua.test_all
59
```

docs/src/unbound_args.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ h() = do_something(T[])
2727
h(x1::T, x2::T...) = do_something(T[x1, x2...])
2828
```
2929

30+
## [Test function](@id test_unbound_args)
31+
3032
```@docs
3133
Aqua.test_unbound_args
3234
```

src/Aqua.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ include("persistent_tasks.jl")
2424
"""
2525
test_all(testtarget::Module)
2626
27-
Run following tests in isolated testset:
27+
Run the following tests:
2828
2929
* [`test_ambiguities([testtarget, Base, Core])`](@ref test_ambiguities)
3030
* [`test_unbound_args(testtarget)`](@ref test_unbound_args)

0 commit comments

Comments
 (0)