diff src/Grids/grid.jl @ 1279:1157f889bf50 refactor/grids

Clear out some TBDs
author Jonatan Werpers <jonatan@werpers.com>
date Sun, 26 Feb 2023 21:20:52 +0100
parents dcd8654ca33b
children 7de1df0aad6a
line wrap: on
line diff
--- a/src/Grids/grid.jl	Sun Feb 26 21:04:41 2023 +0100
+++ b/src/Grids/grid.jl	Sun Feb 26 21:20:52 2023 +0100
@@ -3,14 +3,12 @@
 
 The top level type for grids.
 
+TODO:
 Should implement
-# TBD:
+ * interfaces for iteration and indexing
 """
-#TBD: Should it be an AbstractArray? See notes in grid_refactor.md
-# TODO: Document that grids should implement the interfaces for iteration and indexing.
 abstract type Grid{T,D} end
 
-
 Base.ndims(::Grid{T,D}) where {T,D} = D
 Base.eltype(::Type{<:Grid{T}}) where T = T
 target_manifold_dim(::Grid{T}) where T = _ncomponents(T) # TBD: Name of this function?!
@@ -45,9 +43,7 @@
 Enumerate the dimensions of the grid.
 """
 dims(grid::Grid) = 1:ndims(grid)
-# TBD: Is this function needed? Where is it used?
-
-# TBD: New file grid_functions.jl?
+# TBD: Is this function needed? Where is it used
 """
 TODO:
 
@@ -63,7 +59,7 @@
 end
 
 
-# TODO: Explain how these are intended to be used
+# TODO: Explain how and where these are intended to be used
 _ncomponents(::Type{<:Number}) = 1
 _ncomponents(T::Type{<:SVector}) = length(T)