Merge pull request #314 from SciML/releasenotes

add release notes
SciML · Jun 1, 2023 · 39e538b · 39e538b
2 parents f3c6dcd + e05acdf
commit 39e538b
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/pages.jl b/docs/pages.jl
@@ -11,4 +11,5 @@ pages = ["index.md",
     "Solvers" => Any["solvers/solvers.md"],
     "Advanced" => Any["advanced/developing.md"
                       "advanced/custom.md"],
+    "Release Notes" => "release_notes.md"
 ]
diff --git a/docs/src/release_notes.md b/docs/src/release_notes.md
@@ -0,0 +1,10 @@
+# Release Notes
+
+## v2.0
+
+* `LinearCache` changed from immutable to mutable. With this, the out of place interfaces like
+  `set_A` were deprecated for simply mutating the cache, `cache.A = ...`. This fixes some
+  correctness checks and makes the package more robust while improving performance.
+* The default algorithm is now type-stable and does not rely on a dynamic dispatch for the choice.
+* IterativeSolvers.jl and KrylovKit.jl were made into extension packages. 
+* Documentation of the solvers has changed to docstrings