Skip to content

Commit d322a98

Browse files
committed
update documentation
1 parent b99e045 commit d322a98

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/p_range.jl

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -548,12 +548,14 @@ interface.
548548
- `ranks`: Array containing the distribution of ranks.
549549
- `np::NTuple{N}`: Number of parts per direction.
550550
- `n::NTuple{N}`: Number of global indices per direction.
551-
- `ghost::NTuple{N}=ntuple(i->false,N)`: Use or not ghost indices per direction.
551+
- `ghost::NTuple{N}=ntuple(i->false,N)`: Number of ghost indices per direction.
552552
- `periodic::NTuple{N}=ntuple(i->false,N)`: Use or not periodic boundaries per direction.
553553
554554
For convenience, one can also provide scalar inputs instead tuples
555555
to create 1D block partitions. In this case, the argument `np` can be omitted
556-
and it will be computed as `np=length(ranks)`.
556+
and it will be computed as `np=length(ranks)`. At the moment, it's only possible
557+
to use this syntax for zero (with `ghost=false`) or one (with `ghost=true`) layer(s)
558+
of ghost indices. If you wish to have more ghost indices, use tuples instead.
557559
558560
# Examples
559561

0 commit comments

Comments
 (0)