Skip to content

Commit

Permalink
Make example self-contained
Browse files Browse the repository at this point in the history
  • Loading branch information
utkinis committed Nov 25, 2023
1 parent 33aa6e9 commit 9c27824
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
7 changes: 0 additions & 7 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,6 @@ using FastIce

push!(LOAD_PATH,"../src/")

const DOC_SETUP = quote
using FastIce
using FastIce.Grids
end

DocMeta.setdocmeta!(FastIce, :DocTestSetup, DOC_SETUP; recursive=true)

makedocs(
sitename = "FastIce",
authors="Ludovic Räss, Ivan Utkin and contributors",
Expand Down
5 changes: 4 additions & 1 deletion src/Grids/cartesian_grid.jl
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
"""
Rectilinear grid with uniform spacing.
# Examples
Examples
========
```jldoctest
julia> using FastIce.Grids
julia> grid = CartesianGrid(origin=(0.0,0.0), extent=(1.0,1.0), size=(4,4))
2D 4×4 CartesianGrid{Float64}:
x ∈ [0.0–1.0]; Δx = 0.25
Expand Down

0 comments on commit 9c27824

Please sign in to comment.