Mercurial > repos > public > sbplib_julia

diff src/Grids/equidistant_grid.jl @ 1335:cca45af5e724 refactor/grids

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Some docs for EquidistantGrid
author Jonatan Werpers <jonatan@werpers.com>
date Wed, 03 May 2023 15:49:37 +0200
parents ed3ea0630825
children 760a4a1ec4b7
line wrap: on
line diff
--- a/src/Grids/equidistant_grid.jl	Wed May 03 15:41:45 2023 +0200
+++ b/src/Grids/equidistant_grid.jl	Wed May 03 15:49:37 2023 +0200
@@ -1,9 +1,15 @@
 """
     EquidistantGrid{T,R<:AbstractRange{T}} <: Grid{T,1}
 
-TODO
+A one-dimensional equidistant grid. Most users are expected to use
+[`equidistant_grid`](@ref) for constructing equidistant grids.
+
+See also: [`equidistant_grid`](@ref)
+
+
+## Note
+The type of range used for the points can likely impact performance.
 """
-#TODO: Document recomendations for type of range. (LinRange is faster?)
 struct EquidistantGrid{T,R<:AbstractRange{T}} <: Grid{T,1}
     points::R
 end