Merge pull request #81 from gustaphe/deprecate

Add deprecation notices
jw3126 · Oct 3, 2022 · ae26046 · ae26046 · gustaphe · Oct 3, 2022
2 parents 6e1d43e + 630cbac
commit ae26046
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 6 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,20 +1,22 @@
 name = "UnitfulRecipes"
 uuid = "42071c24-d89e-48dd-8a24-8a12d9b8861f"
 authors = ["Benoit Pasquier", "David Gustavsson", "Jan Weidner"]
-version = "1.6.0"
+version = "1.6.1"
 
 [deps]
 RecipesBase = "3cdcf5f2-1ef4-517c-9805-6587b60abb01"
 Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
 
-[compat]
-RecipesBase = "1.0"
-Unitful = "0.16, 0.17, 0.18, 1.0"
-julia = "1.0"
-
 [extras]
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
 test = ["Test", "Plots"]
+
+[compat]
+RecipesBase = "1.0"
+Plots = "<1.34.2"
+Unitful = "0.16, 0.17, 0.18, 1.0"
+julia = "1.0"
+
diff --git a/README.md b/README.md
@@ -2,6 +2,14 @@
 
 *for plotting data with units seamlessly in Julia*
 
+## Deprecation
+
+As of Plots.jl `v1.34.2`, UnitfulRecipes is included in Plots, and is no longer
+necessary. Instead, loading both Unitful.jl and Plots.jl suffices to plot
+unitful data.
+
+## Archive
+
 <p>
   <a href="https://jw3126.github.io/UnitfulRecipes.jl/stable/">
     <img src="https://img.shields.io/github/workflow/status/jw3126/UnitfulRecipes.jl/Documentation?style=for-the-badge&label=Documentation&logo=Read%20the%20Docs&logoColor=white">

diff --git a/docs/Project.toml b/docs/Project.toml
@@ -6,3 +6,4 @@ Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
 
 [compat]
 Documenter = "0.27"
+Plots = "< 1.34.2"
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -2,6 +2,14 @@
 
 *for plotting data with units seamlessly in Julia*
 
+## Deprecation
+
+As of Plots.jl `v1.34.1`, UnitfulRecipes is included in Plots, and is no longer
+necessary. Instead, loading both Unitful.jl and Plots.jl suffices to plot
+unitful data.
+
+## Archive 
+
 [UnitfulRecipes.jl](https://github.com/jw3126/UnitfulRecipes.jl) provides recipes for plotting figures ([Plots.jl](https://github.com/JuliaPlots/Plots.jl)) when using data with units ([Unitful.jl](https://github.com/PainterQubits/Unitful.jl)).
 
 

diff --git a/src/UnitfulRecipes.jl b/src/UnitfulRecipes.jl
@@ -6,6 +6,17 @@ export @P_str
 
 const clims_types = (:contour, :contourf, :heatmap, :surface)
 
+function __init__()
+    @warn """
+    UnitfulRecipes has been deprecated.
+
+    ```
+    using Unitful, Plots
+    ```
+    should suffice to plot unitful data.
+    """
+end
+
 #==========
 Main recipe
 ==========#
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,3 +6,4 @@ Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"

		[compat]
		Documenter = "0.27"
		Plots = "< 1.34.2"