Skip to content

Commit

Permalink
Make README and docs consistent
Browse files Browse the repository at this point in the history
  • Loading branch information
lgoettgens committed Nov 13, 2023
1 parent b943093 commit 2f737ad
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 11 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,10 @@ Aqua.jl provides functions to run a few automatable checks for Julia packages:
* There are no undefined `export`s.
* There are no unbound type parameters.
* There are no stale dependencies listed in `Project.toml`.
* Check that test target of the root project `Project.toml` and test project
(`test/Project.toml`) are consistent.
* Check that all external packages listed in `deps` have corresponding
`compat` entry.
* Check that test target of the root project `Project.toml` and test project (`test/Project.toml`) are consistent.
* Check that all external packages listed in `deps` have corresponding `compat` entries.
* There are no "obvious" type piracies.
* The package does not create any persistent Tasks that might block precompilation of dependencies.

See more in the [documentation](https://juliatesting.github.io/Aqua.jl/).

Expand Down
11 changes: 4 additions & 7 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@ Aqua.jl provides functions to run a few automatable checks for Julia packages:
* There are no undefined `export`s.
* There are no unbound type parameters.
* There are no stale dependencies listed in `Project.toml`.
* Check that test target of the root project `Project.toml` and test project
(`test/Project.toml`) are consistent.
* Check that all external packages listed in `deps` have corresponding
`compat` entry.
* Check that test target of the root project `Project.toml` and test project (`test/Project.toml`) are consistent.
* Check that all external packages listed in `deps` have corresponding `compat` entries.
* There are no "obvious" type piracies.
* The package does not create any persistent Tasks that might block precompilation of dependencies.

Expand Down Expand Up @@ -78,15 +76,14 @@ using Aqua
Aqua.test_all(
YourPackage;
ambiguities=(exclude=[SomePackage.some_function], broken=true),
unbound_args=true,
undefined_exports=true,
project_extras=true,
stale_deps=(ignore=[:SomePackage],),
deps_compat=(ignore=[:SomeOtherPackage],),
piracies=false,
)
end
```
Note, that for all tests with no explicit options provided, the default options are used.

For more details on the options, see the respective functions [below](@ref test_functions).

### Example uses
Expand Down

0 comments on commit 2f737ad

Please sign in to comment.