Fix docs for low-level MPITopology constructor

Closes #71
jipolanco · Jan 24, 2023 · c796146 · c796146
1 parent 39b611c
commit c796146
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/docs/src/MPITopology.md b/docs/src/MPITopology.md
@@ -41,8 +41,10 @@ and pass that to `MPITopology`:
 ```julia
 dims = (3, 4)
 comm_cart = MPI.Cart_create(comm, dims)
-topology = MPITopology(comm_cart)
+topology = MPITopology{2}(comm_cart)  # note the "{2}"!!
 ```
+Note that in this case, one needs to indicate the number of dimensions `M` of
+the decomposition (here `M = 2`).
 
 ## Types