Merge pull request #2961 from CliMA/ncc/lat-lon-doc

Add a note about default lat-lon topologies
CliMA · Mar 7, 2023 · 167b7cf · 167b7cf · navidcy · Mar 7, 2023
2 parents 09ff3a9 + e174161
commit 167b7cf
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/Grids/latitude_longitude_grid.jl b/src/Grids/latitude_longitude_grid.jl
@@ -120,7 +120,9 @@ Keyword arguments
 
 - `topology`: Tuple of topologies (`Flat`, `Bounded`, `Periodic`) for each direction. The vertical 
               `topology[3]` must be `Bounded`, while the latitude-longitude topologies can be
-              `Bounded`, `Periodic`, or `Flat`.
+              `Bounded`, `Periodic`, or `Flat`. If no topology is provided then, by default, the
+              topology is (`Periodic`, `Bounded`, `Bounded`) if the latitudinal extent is 360 degrees
+              or (`Bounded`, `Bounded`, `Bounded`) otherwise.
 
 - `precompute_metrics`: Boolean specifying whether to precompute horizontal spacings and areas.
                         Default: `true`. When `false`, horizontal spacings and areas are computed