From eb6865fc61cdb88eca4daf6f87d549195a2229d5 Mon Sep 17 00:00:00 2001
From: josidd <joseph.siddons@noc.ac.uk>
Date: Thu, 12 Dec 2024 09:25:15 +0000
Subject: [PATCH] docs: add docstrings for modules

---
 GeoSpatialTools/distance_metrics.py | 2 ++
 GeoSpatialTools/great_circle.py     | 7 ++++++-
 GeoSpatialTools/kdtree.py           | 8 +++++++-
 GeoSpatialTools/neighbours.py       | 6 +++++-
 GeoSpatialTools/octtree.py          | 9 +++++++++
 GeoSpatialTools/quadtree.py         | 6 +++++-
 6 files changed, 34 insertions(+), 4 deletions(-)

diff --git a/GeoSpatialTools/distance_metrics.py b/GeoSpatialTools/distance_metrics.py
index 339b0fc..024360d 100644
--- a/GeoSpatialTools/distance_metrics.py
+++ b/GeoSpatialTools/distance_metrics.py
@@ -1,4 +1,6 @@
 """
+Distance Metrics
+----------------
 Functions for computing navigational information. Can be used to add
 navigational information to DataFrames.
 """
diff --git a/GeoSpatialTools/great_circle.py b/GeoSpatialTools/great_circle.py
index b2cb6d9..b6a2882 100644
--- a/GeoSpatialTools/great_circle.py
+++ b/GeoSpatialTools/great_circle.py
@@ -1,4 +1,9 @@
-"""Class for a Great Circle object."""
+"""
+GreatCircle
+-----------
+Constructors and methods for interacting with GreatCircle objects, including
+comparisons between GreatCircle objects.
+"""
 
 import numpy as np
 
diff --git a/GeoSpatialTools/kdtree.py b/GeoSpatialTools/kdtree.py
index 7da9df6..7151bc6 100644
--- a/GeoSpatialTools/kdtree.py
+++ b/GeoSpatialTools/kdtree.py
@@ -1,6 +1,12 @@
 """
+KDTree
+------
 An implementation of KDTree using Haversine Distance for GeoSpatial analysis.
-Useful tool for quickly searching for nearest neighbours.
+Useful tool for quickly searching for nearest neighbours. The implementation is
+a K=2 or 2DTree as only 2 dimensions (longitude and latitude) are used.
+
+Haversine distances are used for comparisons, so that the spherical geometry
+of the earth is accounted for.
 """
 
 from . import Record
diff --git a/GeoSpatialTools/neighbours.py b/GeoSpatialTools/neighbours.py
index 02143fc..0d86e8a 100644
--- a/GeoSpatialTools/neighbours.py
+++ b/GeoSpatialTools/neighbours.py
@@ -1,4 +1,8 @@
-"""Functions for finding nearest neighbours using bisection."""
+"""
+Neighbours
+----------
+Functions for finding nearest neighbours using bisection.
+"""
 
 from numpy import argmin
 from bisect import bisect
diff --git a/GeoSpatialTools/octtree.py b/GeoSpatialTools/octtree.py
index 029ff9e..79542ff 100644
--- a/GeoSpatialTools/octtree.py
+++ b/GeoSpatialTools/octtree.py
@@ -1,3 +1,12 @@
+"""
+OctTree
+-------
+Constuctors for OctTree classes that can decrease the number of comparisons
+for detecting nearby records for example. This is an implementation that uses
+Haversine distances for comparisons between records for identification of
+neighbours.
+"""
+
 from dataclasses import dataclass
 from typing import List, Optional
 import datetime
diff --git a/GeoSpatialTools/quadtree.py b/GeoSpatialTools/quadtree.py
index 214bc38..90a22c7 100644
--- a/GeoSpatialTools/quadtree.py
+++ b/GeoSpatialTools/quadtree.py
@@ -1,6 +1,10 @@
 """
+QuadTree
+--------
 Constuctors for QuadTree classes that can decrease the number of comparisons
-for detecting nearby records for example
+for detecting nearby records for example. This is an implementation that uses
+Haversine distances for comparisons between records for identification of
+neighbours.
 """
 
 from dataclasses import dataclass
-- 
GitLab