fix docs

LeeoBianchi · Jan 3, 2024 · fb87415 · fb87415
1 parent 8a38df4
commit fb87415
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 12 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -7,15 +7,15 @@ using LinearAlgebra
 using Healpix
 
 makedocs(
-         sitename = "HealpixMPI.jl",
-         modules  = [HealpixMPI],
-         pages=[
-                "Introduction" => "index.md"
-                "Distributed Classes" => "distribute.md"
-                "Spherical Harmonics" => "sht.md"
-                "Miscellanea" => "misc.md"
-               ])
-
+    sitename = "HealpixMPI.jl",
+    modules  = [HealpixMPI],
+    pages=[
+        "Introduction" => "index.md"
+        "Distributed Classes" => "distribute.md"
+        "Spherical Harmonics" => "sht.md"
+        "Miscellanea" => "misc.md"
+       ],
+    checkdocs = :exports)
 deploydocs(
     repo="github.com/LeeoBianchi/HealpixMPI.jl.git",
 )
diff --git a/docs/src/distribute.md b/docs/src/distribute.md
@@ -10,7 +10,9 @@ As mentioned in the introduction, HealpixMPI has the main purpose of providing a
 This is made possible by the implementation of two data types: [`DMap`](@ref) and [`DAlm`](@ref), mirroring [`HealpixMap`](https://ziotom78.github.io/Healpix.jl/stable/mapfunc/#Healpix.HealpixMap) and [`Alm`](https://ziotom78.github.io/Healpix.jl/stable/alm/#Healpix.Alm) types of Healpix.jl respectively, and containing a well-defined subset of a map or harmonic coefficients, to be constructed on each MPI task.
 
 ```@docs
+AbstractDMap
 DMap
+AbstractDAlm
 DAlm
 ```
 

diff --git a/src/HealpixMPI.jl b/src/HealpixMPI.jl
@@ -4,7 +4,7 @@ export Strategy, RR
 export AlmInfoMPI, DAlm, AbstractDAlm
 export GeomInfoMPI, DMap, AbstractDMap
 export make_mstart_complex, get_nm_RR, get_mval_RR, get_m_tasks_RR
-export ring2theta, get_equator_idx, get_ring_pixels, get_nrings_RR, get_rindexes_RR
+export ring2theta, get_equator_idx, get_ring_pixels, get_nrings_RR, get_rindexes_RR, get_rindexes_tot_RR
 export communicate_alm2map!, communicate_map2alm!
 export ≃
 

diff --git a/src/map.jl b/src/map.jl
@@ -119,16 +119,17 @@ function get_rindexes_RR(local_nrings::Integer, eq_idx::Integer, t_rank::Integer
     end
     rings
 end
+
 function get_rindexes_RR(nside::Integer, t_rank::Integer, c_size::Integer)::Vector{Int}
     eq_idx = Healpix.getEquatorIdx(nside)
     nrings = get_nrings_RR(eq_idx, t_rank, c_size)
     get_rindexes_RR(nrings, eq_idx, t_rank, c_size)
 end
 
 """
-    get_rindexes_tot_RR(eq_idx::Integer, c_size::Integer)
+    get_rindexes_tot_RR(eq_index::Integer, c_size::Integer)
 
-Return array of ring indexes ordered by task first and RR within each task
+Return array of ring indexes ordered by task first and RR within each task.
 """
 function get_rindexes_tot_RR(eq_index::Integer, c_size::Integer)
     filled = 1 #we keep track of how much of rindexes we already have filled