Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

typos and Aqua CI #276

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@ updates:
directory: "/" # Location of package manifests
schedule:
interval: "weekly"
ignore:
- dependency-name: "crate-ci/typos"
update-types: ["version-update:semver-patch"]
13 changes: 13 additions & 0 deletions .github/workflows/SpellCheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Spell Check

on: [pull_request]

jobs:
typos-check:
name: Spell Check with Typos
runs-on: ubuntu-latest
steps:
- name: Checkout Actions Repository
uses: actions/checkout@v3
- name: Check spelling
uses: crate-ci/[email protected]
2 changes: 2 additions & 0 deletions .typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[default.extend-words]
extrapolant = "extrapolant"
3 changes: 3 additions & 0 deletions Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@ SimpleUnPack = "ce78b400-467f-4804-87d8-8f486da07d0a"
ArrayInterface = "6, 7"
DataStructures = "0.18"
DiffEqBase = "6.122"
LinearAlgebra = "1"
Logging = "1"
Comment on lines +24 to +25
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's an unfortunate problem (https://discourse.julialang.org/t/psa-compat-requirements-in-the-general-registry-are-changing/104958#update-november-9th-2023-2) that means it is generally safer to use

Suggested change
LinearAlgebra = "1"
Logging = "1"
LinearAlgebra = "<0.0.1, 1"
Logging = "<0.0.1, 1"

OrdinaryDiffEq = "6.49.1"
Printf = "1"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Printf = "1"
Printf = "<0.0.1, 1"

RecursiveArrayTools = "2, 3"
Reexport = "0.2, 1.0"
SciMLBase = "1.90, 2"
Expand Down
2 changes: 1 addition & 1 deletion src/integrators/interface.jl
Original file line number Diff line number Diff line change
Expand Up @@ -491,7 +491,7 @@ end
DiffEqBase.has_stats(::DDEIntegrator) = true

# https://github.com/SciML/OrdinaryDiffEq.jl/pull/1753
# Backwards compatability
# Backwards compatibility
@static if isdefined(OrdinaryDiffEq, :DEPRECATED_ADDSTEPS)
const _ode_addsteps! = OrdinaryDiffEq._ode_addsteps!
const ode_addsteps! = OrdinaryDiffEq.ode_addsteps!
Expand Down
2 changes: 2 additions & 0 deletions test/Project.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[deps]
Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
DDEProblemLibrary = "f42792ee-6ffc-4e2a-ae83-8ee2f22de800"
DiffEqBase = "2b5f629d-d688-5b77-993f-72d75c75574e"
DiffEqCallbacks = "459566f4-90b8-5000-8ac3-15dfb0a30def"
Expand All @@ -14,4 +15,5 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"

[compat]
Aqua = "0.8"
DDEProblemLibrary = "0.1.2"
13 changes: 13 additions & 0 deletions test/qa.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
using DelayDiffEq, Aqua
@testset "Aqua" begin
Aqua.find_persistent_tasks_deps(DelayDiffEq)
Aqua.test_ambiguities(DelayDiffEq, recursive = false)
Aqua.test_deps_compat(DelayDiffEq)
Aqua.test_piracies(DelayDiffEq,
treat_as_own = [DelayDiffEq.SciMLBase.DESolution,
DelayDiffEq.SciMLBase.SciMLSolution])
Aqua.test_project_extras(DelayDiffEq)
Aqua.test_stale_deps(DelayDiffEq)
Aqua.test_unbound_args(DelayDiffEq)
Aqua.test_undefined_exports(DelayDiffEq)
Comment on lines +3 to +12
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, I'd prefer to use Aqua.test_all to not miss out on any tests in the future (again, it seems there's some fine-tuning with keyword arguments necessary anyway).
Since the ambiguity check is problematic currently, I suggest (as e.g. in Distributions and Pumas) using

Suggested change
Aqua.find_persistent_tasks_deps(DelayDiffEq)
Aqua.test_ambiguities(DelayDiffEq, recursive = false)
Aqua.test_deps_compat(DelayDiffEq)
Aqua.test_piracies(DelayDiffEq,
treat_as_own = [DelayDiffEq.SciMLBase.DESolution,
DelayDiffEq.SciMLBase.SciMLSolution])
Aqua.test_project_extras(DelayDiffEq)
Aqua.test_stale_deps(DelayDiffEq)
Aqua.test_unbound_args(DelayDiffEq)
Aqua.test_undefined_exports(DelayDiffEq)
# Test ambiguities separately without Base and Core
# Ref: https://github.com/JuliaTesting/Aqua.jl/issues/77
Aqua.test_all(DelayDiffEq; ambiguities = false)
Aqua.test_ambiguities(DelayDiffEq)

end
1 change: 1 addition & 0 deletions test/runtests.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ using SafeTestsets
const GROUP = get(ENV, "GROUP", "All")

if GROUP == "All" || GROUP == "Interface"
@time @safetestset "Quality Assurance" begin include("qa.jl") end
@time @safetestset "AD Tests" begin include("interface/ad.jl") end
@time @safetestset "Backwards Tests" begin include("interface/backwards.jl") end
@time @safetestset "Composite Solution Tests" begin include("interface/composite_solution.jl") end
Expand Down
Loading