Adding draft TiltRegion creation documentation

GeoRegionsEcosystem · Sep 8, 2024 · 2cd814d · 2cd814d
1 parent e7548b0
commit 2cd814d
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/docs/src/tutorials/create/tiltregion.md b/docs/src/tutorials/create/tiltregion.md
@@ -0,0 +1,25 @@
+# Defining New `TiltRegion`s
+
+Text
+
+```julia
+TiltRegion(ID, pID, name, X, Y, ΔX, ΔY, θ)
+```
+
+## Example
+
+As an example construct the sample `TiltRegion`, with `ID` `TTR`, `pID` `GLB` and with the `name` as `Test Rectangle Region`
+
+```@repl
+using GeoRegions
+RectRegion("TTR","GLB","Test Rectangle Region",10,5,50,20,30)
+```
+
+## API
+
+```@docs
+TiltRegion(
+    ::AbstractString, ::AbstractString, ::AbstractString,
+    ::Real, ::Real, ::Real, ::Real, ::Real
+)
+```