diff --git a/README.md b/README.md
index 0bd4ef6..2ed4733 100644
--- a/README.md
+++ b/README.md
@@ -6,12 +6,12 @@
[](https://codecov.io/gh/SciML/CommonSolve.jl)
[](https://github.com/SciML/CommonSolve.jl/actions?query=workflow%3ACI)
-[](https://github.com/SciML/ColPrac)
+[](https://github.com/SciML/ColPrac)
[](https://github.com/SciML/SciMLStyle)
This holds the common `solve`, `init`, `step!`, and `solve!` commands. By using the same definition,
solver libraries from other completely different ecosystems can extend the functions and thus
-not clash with SciML if both ecosystems export the `solve` command. The rules are that
+not clash with SciML if both ecosystems export the `solve` command. The rules are that
you must dispatch on one of your own types. That's it. No pirates.
## General recommendation
@@ -25,14 +25,14 @@ solve(args...; kwargs...) = solve!(init(args...; kwargs...))
So, we recommend defining
```julia
-init(::ProblemType, args...; kwargs...) :: SolverType
-solve!(::SolverType) :: SolutionType
+init(::ProblemType, args...; kwargs...)::SolverType
+solve!(::SolverType)::SolutionType
```
where `ProblemType`, `SolverType`, and `SolutionType` are the types defined in
-your package.
+your package.
-In many cases, the `SolverType` is an object that is iteratively progressed to achieve the solution.
+In many cases, the `SolverType` is an object that is iteratively progressed to achieve the solution.
In such cases, the `step!` function can be used:
```julia
diff --git a/docs/make.jl b/docs/make.jl
index 2e310e7..cae3837 100644
--- a/docs/make.jl
+++ b/docs/make.jl
@@ -12,9 +12,9 @@ makedocs(
clean = true, doctest = false, linkcheck = true,
format = Documenter.HTML(
assets = ["assets/favicon.ico"],
- canonical = "https://docs.sciml.ai/CommonSolve/stable",
+ canonical = "https://docs.sciml.ai/CommonSolve/stable"
),
- pages = pages,
+ pages = pages
)
deploydocs(repo = "github.com/SciML/CommonSolve.jl.git"; push_preview = true)
diff --git a/docs/src/index.md b/docs/src/index.md
index 11a42b1..d6881ac 100644
--- a/docs/src/index.md
+++ b/docs/src/index.md
@@ -25,16 +25,15 @@ solve(args...; kwargs...) = solve!(init(args...; kwargs...))
So, we recommend defining
```julia
-init(::ProblemType, args...; kwargs...) :: SolverType
-solve!(::SolverType) :: SolutionType
+init(::ProblemType, args...; kwargs...)::SolverType
+solve!(::SolverType)::SolutionType
```
where `ProblemType`, `SolverType`, and `SolutionType` are the types defined in
-your package.
+your package.
In many cases, the `SolverType` is an object that is iteratively progressed to achieve the solution. In such cases, the `step!` function can be used:
-
```julia
step!(::SolverType, args...; kwargs...)
```
@@ -73,36 +72,46 @@ CommonSolve.step!
+ See also [SciML Community page](https://sciml.ai/community/)
## Reproducibility
+
```@raw html
The documentation of this SciML package was built using these direct dependencies,
```
+
```@example
using Pkg # hide
Pkg.status() # hide
```
+
```@raw html
```
+
```@raw html
and using this machine and Julia version.
```
+
```@example
using InteractiveUtils # hide
versioninfo() # hide
```
+
```@raw html
```
+
```@raw html
A more complete overview of all dependencies and their versions is also provided.
```
+
```@example
using Pkg # hide
-Pkg.status(;mode = PKGMODE_MANIFEST) # hide
+Pkg.status(; mode = PKGMODE_MANIFEST) # hide
```
+
```@raw html
```
+
```@eval
using TOML
using Markdown
diff --git a/test/runtests.jl b/test/runtests.jl
index ba6e69e..12e543b 100644
--- a/test/runtests.jl
+++ b/test/runtests.jl
@@ -1,3 +1,5 @@
using SafeTestsets
-@time @safetestset "Quality Assurance" begin include("qa.jl") end
+@time @safetestset "Quality Assurance" begin
+ include("qa.jl")
+end