Mercurial > repos > public > sbplib_julia
diff src/Grids/equidistant_grid.jl @ 1347:08f06bfacd5c refactor/grids
Fix typos and formatting of documentation
author | Vidar Stiernström <vidar.stiernstrom@it.uu.se> |
---|---|
date | Thu, 18 May 2023 22:53:31 +0200 |
parents | 760a4a1ec4b7 |
children | 4684c7f1c4cb |
line wrap: on
line diff
--- a/src/Grids/equidistant_grid.jl Mon May 15 22:54:32 2023 +0200 +++ b/src/Grids/equidistant_grid.jl Thu May 18 22:53:31 2023 +0200 @@ -53,8 +53,8 @@ """ refine(g::EquidistantGrid, r::Int) -Refines `grid` by a factor `r`. The factor is applied to the number of -intervals which is 1 less than the size of the grid. +The grid where `g` is refined by the factor `r`. The factor is applied to the number of +intervals, i.e., 1 less than the size of `g`. See also: [`coarsen`](@ref) """ @@ -64,10 +64,10 @@ end """ - coarsen(grid::EquidistantGrid, r::Int) + coarsen(g::EquidistantGrid, r::Int) -Coarsens `grid` by a factor `r`. The factor is applied to the number of -intervals which is 1 less than the size of the grid. If the number of +The grid where `g` is coarsened by the factor `r`. The factor is applied to the number of +intervals, i.e., 1 less than the size of `g`. If the number of intervals are not divisible by `r` an error is raised. See also: [`refine`](@ref) @@ -94,7 +94,7 @@ `limit_upper=(1,2)` the domain is defined as `(-1,1)x(0,2)`. The side lengths of the grid are not allowed to be negative. -The number of equidistantly spaced points in each coordinate direction are given +The number of equispaced points in each coordinate direction are given by the tuple `size`. Note: If `limit_lower` and `limit_upper` are integers and `size` would allow a @@ -127,9 +127,9 @@ """ - change_length(::AbstractRange, n) + change_length(r::AbstractRange, n) -Change the length of a range to `n`, keeping the same start and stop. +Change the length of `r` to `n`, keeping the same start and stop. """ function change_length end