Skip to content

Commit

Permalink
docs: fixing docstrings with wrong names of plotting recipe functions
Browse files Browse the repository at this point in the history
  • Loading branch information
AtilaSaraiva committed Feb 21, 2025
1 parent 1388fe5 commit 555324d
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 20 deletions.
8 changes: 4 additions & 4 deletions src/Recipes/SeisAmplitudeRecipe.jl
Original file line number Diff line number Diff line change
@@ -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`.
Expand All @@ -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)
Expand Down
8 changes: 4 additions & 4 deletions src/Recipes/SeisFKRecipe.jl
Original file line number Diff line number Diff line change
@@ -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`.
Expand All @@ -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)
Expand Down
8 changes: 4 additions & 4 deletions src/Recipes/SeisImageRecipe.jl
Original file line number Diff line number Diff line change
@@ -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`.
Expand All @@ -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)
Expand Down
8 changes: 4 additions & 4 deletions src/Recipes/SeisOverlayRecipe.jl
Original file line number Diff line number Diff line change
@@ -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`.
Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions src/Recipes/SeisWiggleRecipe.jl
Original file line number Diff line number Diff line change
@@ -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`.
Expand All @@ -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`
Expand Down

0 comments on commit 555324d

Please sign in to comment.