From 5fd32c79ffba44fae7a0f8234a6799defb450556 Mon Sep 17 00:00:00 2001 From: nicomerino Date: Tue, 18 Jun 2024 19:00:42 +0200 Subject: [PATCH] Update doc --- src/kernel/outwards.jl | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/kernel/outwards.jl b/src/kernel/outwards.jl index 7c14f27..d19cc9f 100644 --- a/src/kernel/outwards.jl +++ b/src/kernel/outwards.jl @@ -29,8 +29,10 @@ is occupied. Default is 1.0. - `distancemethod`: [`DistanceMethod`](@ref) object for calculating distance between cells. The default is [`CentroidToCentroid`](@ref). -- `mask_flag`: Use `Mask()` to apply masking. Default is `NoMask()`. Using Mask() will cause - a drop in performance. +- `mask_flag`: The default setting is `NoMask()`. Use `Mask()` to indicate that the grid is + masked, enabling the rule to perform boundary checking at mask edges. Not using + `Mask()` on a masked grid may result in the loss of individuals at the edges, but it comes + at a performance cost. Pass grid name `Symbol`s to `R` and `W` type parameters to use specific grids. """