From c2e58af0b759ac0bc408cc78be473ada6ff69acf Mon Sep 17 00:00:00 2001
From: josidd <joseph.siddons@noc.ac.uk>
Date: Fri, 4 Oct 2024 14:20:55 +0100
Subject: [PATCH] docs: correct documentation re: sorted-ness error from
bisect.
---
GeoSpatialTools/neighbours.py | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/GeoSpatialTools/neighbours.py b/GeoSpatialTools/neighbours.py
index d13b637..82c562e 100644
--- a/GeoSpatialTools/neighbours.py
+++ b/GeoSpatialTools/neighbours.py
@@ -1,3 +1,5 @@
+"""Functions for finding nearest neighbours using bisection."""
+
from numpy import argmin
from bisect import bisect
from typing import TypeVar
@@ -26,18 +28,17 @@ def find_nearest(vals: list[Numeric], test: list[Numeric]) -> list[int]:
Uses bisection for speediness!
- Arguments
- =========
+ Parameters
+ ----------
vals : list[Numeric]
List of values - this is the pool of values for which we are looking
for a nearest match. This list MUST be sorted. Sortedness is not
- checked, nor is the list sorted. An error will be raised if the list
- is not sorted.
+ checked, nor is the list sorted.
test : list[Numeric]
List of query values
Returns
- =======
+ -------
A list containing the index of the nearest neighbour in vals for each value
in test.
"""
--
GitLab