From 2f737adb4bfcf68e744726749499e9cd6c7a5ae3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20G=C3=B6ttgens?= Date: Thu, 26 Oct 2023 12:34:44 +0200 Subject: [PATCH] Make README and docs consistent --- README.md | 7 +++---- docs/src/index.md | 11 ++++------- 2 files changed, 7 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 47c8061c..41752296 100644 --- a/README.md +++ b/README.md @@ -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/). diff --git a/docs/src/index.md b/docs/src/index.md index b0c592bf..155a101e 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -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. @@ -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