Add docstrings to submodules

JuliaEarth · May 20, 2024 · 024b4aa · 024b4aa
1 parent 727a24d
commit 024b4aa
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 0 deletions.
diff --git a/src/gadm.jl b/src/gadm.jl
@@ -2,6 +2,10 @@
 # Licensed under the MIT License. See LICENSE in the project root.
 # -----------------------------------------------------------------
 
+"""
+Provides a single function `GADM.get` to download data from the GADM database.
+Please check its docstring for more details.
+"""
 module GADM
 
 using GeoIO

diff --git a/src/geostatsimages.jl b/src/geostatsimages.jl
@@ -2,6 +2,11 @@
 # Licensed under the MIT License. See LICENSE in the project root.
 # -----------------------------------------------------------------
 
+"""
+Provides a single function `GeoStatsImages.get` to load images
+from geostatistics literature. Please check its docstring for
+more details.
+"""
 module GeoStatsImages
 
 using GeoStatsImages

diff --git a/src/inmet.jl b/src/inmet.jl
@@ -2,6 +2,12 @@
 # Licensed under the MIT License. See LICENSE in the project root.
 # -----------------------------------------------------------------
 
+"""
+Provides functions to load data from the INMET API.
+Please check their docstrings for more details:
+
+- `INMET.stations`
+"""
 module INMET
 
 using Meshes

diff --git a/src/naturalearth.jl b/src/naturalearth.jl
@@ -2,6 +2,10 @@
 # Licensed under the MIT License. See LICENSE in the project root.
 # -----------------------------------------------------------------
 
+"""
+Provides a single function `NaturalEarth.get` to download data from the
+NaturalEarth database.  Please check its docstring for more details.
+"""
 module NaturalEarth
 
 using GeoIO