Updates to documentation

GeoRegionsEcosystem · Sep 14, 2024 · b469657 · b469657
1 parent 4fbe12d
commit b469657
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/docs/src/basics/create.md b/docs/src/basics/create.md
@@ -2,8 +2,6 @@
 
 Recall that there are three different types of `GeoRegion`s: (a) `RectRegion`s, (b) `TiltRegion`s and (c) `PolyRegion`s.
 
-## Creating new GeoRegions
-
 We use the functions `RectRegion()`, `TiltRegion()` and `PolyRegion` to create new `GeoRegion`s of their respective types. Regardless of `GeoRegion` type, the **first three inputs are always the same**, in respective order:
 1. The ID (`ID`)
 2. parent `GeoRegion` ID, (`pID`)
@@ -15,6 +13,8 @@ TiltRegion(ID, pID, name, ...)
 PolyRegion(ID, pID, name, ...)
 ```
 
+Each of these functions have specific inputs, as seen in the respective sections below.
+
 ## Defining New `RectRegion`s
 
 Out of all three `GeoRegion` types currently available, the `RectRegion` is most straightforward to define. All you need to do is specify the `[N, S, E, W]` boundaries, in that order.
@@ -58,7 +58,7 @@ PolyRegion("TPR","GLB","Test Polygonal Region",[30,40,50,40,30],[20,30,20,10,20]
 
 ## Defining New `TiltRegion`s
 
-Text
+A `TiltRegion` is basically a rectangular region that is rotated. The specification of a `TiltRegion` and its respective `TiltGrid` in [RegionGrids.jl](https://github.com/GeoRegionsEcosystem/RegionGrids.jl) allows us to more easily obtain Hovmoller diagrams for a region of interest that is tilted.
 
 ```julia
 TiltRegion(ID, pID, name, X, Y, ΔX, ΔY, θ)
@@ -68,5 +68,5 @@ As an example construct the sample `TiltRegion`, with `ID` `TTR`, `pID` `GLB` an
 
 ```@repl
 using GeoRegions
-RectRegion("TTR","GLB","Test Rectangle Region",10,5,50,20,30)
+TiltRegion("TTR","GLB","Test Rectangle Region",10,5,50,20,30)
 ```
diff --git a/docs/src/basics/read/tables.md b/docs/src/basics/read/tables.md
@@ -19,6 +19,9 @@ tableTiltRegions()
 tablePolyRegions(srex = true/false, ar6 = true/false, custom = true/false)
 ```
 
+!!! tip "`GLB` Region will always appear"
+    The `GLB` GeoRegion will always appear in the table, because it is the ultimate parent GeoRegion. All other `GeoRegion`s will always in some manner be a subset of the `GLB` GeoRegion.
+
 ## Use Case Examples
 
 :::tabs