Python docstrings are added.

makyol · Jul 14, 2024 · 0607dca · 0607dca
1 parent 18d2c80
commit 0607dca
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/landusemix/indices.py b/landusemix/indices.py
@@ -1,3 +1,6 @@
+"""
+This module contains a class that calculates land use mix indices.
+"""
 import math
 
 class LandUseMixIndices:

diff --git a/landusemix/utils.py b/landusemix/utils.py
@@ -1,4 +1,6 @@
-
+"""
+Utility functions for reading and loading data files. 
+"""
 import json
 import pandas as pd
 import geopandas as gpd