Merge pull request #35 from AtilaSaraiva/version

Updating package version and fixing docs

Project.toml

@@ -1,7 +1,7 @@
 name = "SeisMakie"
 uuid = "1618359f-28d0-421c-9c3d-0705aaf8cc0d"
 authors = ["Firas <firas_alchalabi@hotmail.com>", "Átila <atilasaraiva@gmail.com>"]
-version = "0.2.0"
+version = "0.2.1"
 
 [deps]
 FFTW = "7a1cc6ca-52ef-59f5-83cd-3a7055c09341"
@@ -10,7 +10,7 @@ Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 
 [compat]
 FFTW = "1"
-Makie = "0.20, 0.21"
+Makie = "0.20, 0.21, 0.22"
 Statistics = "1"
 julia = "1"
 

src/Recipes/SeisAmplitudeRecipe.jl

@@ -1,6 +1,6 @@
 """
-    seisamplitude(d; <keyword arguments>)
-    seisamplitude!(ax, d; <keyword arguments>)
+    seisamplitudeplot(d; <keyword arguments>)
+    seisamplitudeplot!(ax, d; <keyword arguments>)
 
 Plot amplitude-frequency 2D seismic data `d`.
 
@@ -19,11 +19,11 @@ Plot amplitude-frequency 2D seismic data `d`.
 # Examples
 ```julia
 julia> d = SeisLinearEvents();
-julia> f, ax, amp = seisamplitude(d)
+julia> f, ax, amp = seisamplitudeplot(d)
 ```
 ```julia
 julia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)
-julia> amp = seisamplitude!(ax, d)
+julia> amp = seisamplitudeplot!(ax, d)
 ```
 
 Author: Firas Al Chalabi (2024)

src/Recipes/SeisFKRecipe.jl

@@ -1,6 +1,6 @@
 """
-    seisfk(d; <keyword arguments>)
-    seisfk!(ax, d; <keyword arguments>)
+    seisfkplot(d; <keyword arguments>)
+    seisfkplot!(ax, d; <keyword arguments>)
 
 Plot frequency-wavenumber 2D seismic data `d`.
 
@@ -26,11 +26,11 @@ Return the figure and axis corresponding to d.
 # Examples
 ```julia
 julia> d = SeisLinearEvents();
-julia> f, ax, fk = seisfk(d)
+julia> f, ax, fk = seisfkplot(d)
 ```
 ```julia
 julia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)
-julia> fk = seisfk!(ax, d)
+julia> fk = seisfkplot!(ax, d)
 ```
 
 Author: Firas Al Chalabi (2024)

src/Recipes/SeisImageRecipe.jl

@@ -1,6 +1,6 @@
 """
-    seisimage(d; <keyword arguments>);
-    seisimage!(ax, d; <keyword arguments>);
+    seisimageplot(d; <keyword arguments>);
+    seisimageplot!(ax, d; <keyword arguments>);
 
 Recipe to plot time-space, color plot of 2D seismic data `d`.
 
@@ -22,11 +22,11 @@ Recipe to plot time-space, color plot of 2D seismic data `d`.
 # Examples
 ```julia
 julia> d = SeisLinearEvents();
-julia> f, ax, img = seisimage(d)
+julia> f, ax, img = seisimageplot(d)
 ```
 ```julia
 julia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)
-julia> img = seisimage!(ax, d)
+julia> img = seisimageplot!(ax, d)
 ```
 
 Author: Firas Al Chalabi (2024)

src/Recipes/SeisOverlayRecipe.jl

@@ -1,6 +1,6 @@
 """
-    seisoverlay(d; <keyword arguments>)
-    seisoverlay!(ax, d; <keyword arguments>)
+    seisoverlayplot(d; <keyword arguments>)
+    seisoverlayplot!(ax, d; <keyword arguments>)
 
 Recipe to plot time-space, overlay plot of 2D seismic data `d`.
 
@@ -27,11 +27,11 @@ Recipe to plot time-space, overlay plot of 2D seismic data `d`.
 # Examples
 ```julia
 julia> d = SeisLinearEvents();
-julia> f, ax, ov = seisoverlay(d)
+julia> f, ax, ov = seisoverlayplot(d)
 ```
 ```julia
 julia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)
-julia> ov = seisoverlay!(ax, d)
+julia> ov = seisoverlayplot!(ax, d)
 ```
 """
 @recipe(SeisOverlayPlot, d) do scene

src/Recipes/SeisWiggleRecipe.jl

@@ -1,6 +1,6 @@
 """
-    seiswiggle(d; <keyword arguments>)
-    seiswiggle!(ax, d; <keyword arguments>)
+    seiswiggleplot(d; <keyword arguments>)
+    seiswiggleplot!(ax, d; <keyword arguments>)
 
 Recipe to plot time-space, wiggle plot of 2D seismic data `d`.
 
@@ -24,11 +24,11 @@ Recipe to plot time-space, wiggle plot of 2D seismic data `d`.
 # Examples
 ```julia
 julia> d = SeisLinearEvents();
-julia> f, ax, wp = seiswiggle(d)
+julia> f, ax, wp = seiswiggleplot(d)
 ```
 ```julia
 julia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)
-julia> wp = seiswiggle!(ax, d)
+julia> wp = seiswiggleplot!(ax, d)
 ```
 
 **Note: animations only work with this recipe if you update the observable `d`