From 8cb413791fdca0f39ff5e2c4f1327faf41bb5cbe Mon Sep 17 00:00:00 2001
From: wvenialbo <wvenialbo@gmail.com>
Date: Fri, 25 Oct 2024 04:37:51 -0300
Subject: [PATCH] docs(dataset): add missing module docstrings

---
 src/GOES_DL/dataset/base/locator_gg.py   | 8 ++++++++
 src/GOES_DL/dataset/goes/constants.py    | 7 +++++++
 src/GOES_DL/dataset/goes/locator_abi.py  | 7 +++++++
 src/GOES_DL/dataset/goes/locator_dc.py   | 8 ++++++++
 src/GOES_DL/dataset/gridsat/constants.py | 7 +++++++
 src/GOES_DL/dataset/locator.py           | 8 ++++++++
 6 files changed, 45 insertions(+)

diff --git a/src/GOES_DL/dataset/base/locator_gg.py b/src/GOES_DL/dataset/base/locator_gg.py
index 1e862f8..f0dcdbc 100644
--- a/src/GOES_DL/dataset/base/locator_gg.py
+++ b/src/GOES_DL/dataset/base/locator_gg.py
@@ -1,3 +1,11 @@
+"""
+Provide GridSat or GOES-R series dataset product locator.
+
+Classes:
+    - ProductLocatorGG: Abstract a GridSat or GOES-R series dataset
+      product locator.
+"""
+
 from abc import abstractmethod
 from datetime import datetime, timezone
 from re import Match, findall, fullmatch
diff --git a/src/GOES_DL/dataset/goes/constants.py b/src/GOES_DL/dataset/goes/constants.py
index c9a1719..61d29bb 100644
--- a/src/GOES_DL/dataset/goes/constants.py
+++ b/src/GOES_DL/dataset/goes/constants.py
@@ -1,3 +1,10 @@
+"""
+Constants for GOES dataset file handling.
+
+This module contains constants used for handling GOES dataset files,
+including file suffixes, date formats, and date patterns.
+"""
+
 GOESR_FILE_SUFFIX: str = ".nc"
 
 GOESR_FILE_DATE_FORMAT: str = "%Y%j%H%M%S%f"
diff --git a/src/GOES_DL/dataset/goes/locator_abi.py b/src/GOES_DL/dataset/goes/locator_abi.py
index 80eae97..a6b78ae 100644
--- a/src/GOES_DL/dataset/goes/locator_abi.py
+++ b/src/GOES_DL/dataset/goes/locator_abi.py
@@ -1,3 +1,10 @@
+"""
+Provide GOES-R Series imagery dataset's ABI product locator.
+
+Classes:
+    - GOESProductLocatorABI: Locator for ABI products.
+"""
+
 from .locator import GOESProductLocator
 
 
diff --git a/src/GOES_DL/dataset/goes/locator_dc.py b/src/GOES_DL/dataset/goes/locator_dc.py
index 47727de..641efdb 100644
--- a/src/GOES_DL/dataset/goes/locator_dc.py
+++ b/src/GOES_DL/dataset/goes/locator_dc.py
@@ -1,3 +1,11 @@
+"""
+Provide GOES-R Series imagery dataset's ABI product locator.
+
+Classes:
+    - GOESProductLocatorABIDC: Locator for ABI products with derived
+      channel.
+"""
+
 from .locator_abi import GOESProductLocatorABI
 
 
diff --git a/src/GOES_DL/dataset/gridsat/constants.py b/src/GOES_DL/dataset/gridsat/constants.py
index d57c1b5..abf1728 100644
--- a/src/GOES_DL/dataset/gridsat/constants.py
+++ b/src/GOES_DL/dataset/gridsat/constants.py
@@ -1,3 +1,10 @@
+"""
+Constants for the GridSat dataset file handling.
+
+This module contains constants used for processing GridSat dataset
+files, including file suffixes, date formats, and product versions.
+"""
+
 GRIDSAT_FILE_SUFFIX: str = ".nc"
 
 B1_FILE_DATE_FORMAT: str = "%Y.%m.%d.%H"
diff --git a/src/GOES_DL/dataset/locator.py b/src/GOES_DL/dataset/locator.py
index bd56dd0..415bd94 100644
--- a/src/GOES_DL/dataset/locator.py
+++ b/src/GOES_DL/dataset/locator.py
@@ -1,3 +1,11 @@
+"""
+Provide product locator for satellite imagery dataset consumers.
+
+Classes:
+    - ProductLocator: Abstract a product locator for satellite imagery
+      dataset consumers.
+"""
+
 from abc import ABC, abstractmethod
 from datetime import datetime