Merge pull request SciML#249 from sathvikbhagavan/sb/major

docs: add NEWS.md to document breaking changes
sathvikbhagavan · May 7, 2024 · bafabdb · bafabdb
2 parents e0e2167 + 9507462
commit bafabdb
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/NEWS.md b/NEWS.md
@@ -0,0 +1,9 @@
+# DataInterpolations v5 Release Notes
+
+## Breaking changes
+
+- `AbstractInterpolation` is not a subtype of `AbstractVector` anymore. This was needed for previous versions of ModelingToolkit.jl to represent splines as vectors.
+- Indexing overloads for `AbstractInterpolation` and the type parameter associated with it are removed. For example - `A` is an interpolation object:
+    - Doing `A[i]` will error. Use `A.u[i]`.
+    - `size(A)` will error. Use `size(A.u)` or `size(A.t)`.
+- Removed deprecated bindings for `ZeroSpline` which is the same as `ConstantInterpolation`.
diff --git a/Project.toml b/Project.toml
@@ -1,6 +1,6 @@
 name = "DataInterpolations"
 uuid = "82cc6244-b520-54b8-b5a6-8a565e85f1d0"
-version = "4.8.0"
+version = "5.0.0"
 
 [deps]
 FindFirstFunctions = "64ca27bc-2ba2-4a57-88aa-44e436879224"