diff src/Grids/grid.jl @ 1336:52087a6c0682 refactor/grids

Mention grids as grid functions
author Jonatan Werpers <jonatan@werpers.com>
date Wed, 03 May 2023 15:50:08 +0200
parents 47e309eac131
children f265799bc2b6
line wrap: on
line diff
--- a/src/Grids/grid.jl	Wed May 03 15:49:37 2023 +0200
+++ b/src/Grids/grid.jl	Wed May 03 15:50:08 2023 +0200
@@ -3,9 +3,11 @@
 
 A grid with coordinates of type `T`, e.g. `SVector{3,Float64}`, and dimension
 `D`. The grid can be embedded in a higher dimension in which case the number
-of indices and the number of components of the coordinatevectors will be
+of indices and the number of components of the coordinate vectors will be
 different.
 
+All grids are expected to behave as a grid function for the coordinates.
+
 `Grids` is top level abstract type for grids. A grid should implement Julia's interfaces for
 indexing and iteration.