From 2cd814d5a932907e2c5a25cebb945f6250c93c81 Mon Sep 17 00:00:00 2001 From: Nathanael Wong Date: Sat, 7 Sep 2024 22:09:10 -0400 Subject: [PATCH] Adding draft TiltRegion creation documentation --- docs/src/tutorials/create/tiltregion.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/src/tutorials/create/tiltregion.md diff --git a/docs/src/tutorials/create/tiltregion.md b/docs/src/tutorials/create/tiltregion.md new file mode 100644 index 00000000..f04b1517 --- /dev/null +++ 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 +) +``` \ No newline at end of file