Skip to content

Commit c183d24

Browse files
author
Chahan Kropf
committed
Correct docstrings
1 parent bc0f0b8 commit c183d24

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

climada/util/coordinates.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1457,11 +1457,11 @@ def _nearest_neighbor_approx(
14571457
coordinates : 2d array
14581458
First column contains latitude, second
14591459
column contains longitude. Each row is a geographic point
1460-
unit : str
1461-
Unit to use for non-exact matching. Only possible value is "degree"
1460+
crs : pyproj crs
1461+
Coordinate reference system (crs) of the input coordinates and centroids.
14621462
threshold : float
1463-
distance threshold in km over which no neighbor will
1464-
be found. Those are assigned with a -1 index
1463+
Assignement threshold in units of the provided crs.
1464+
If the distance to the nearest neighbor exceeds `threshold`, the index `-1` is assigned.
14651465
check_antimedirian: bool, optional
14661466
If True, the nearest neighbor in a strip with lon size equal to threshold around the
14671467
antimeridian is recomputed using the Haversine distance. The antimeridian is guessed from
@@ -1534,11 +1534,11 @@ def _nearest_neighbor_haversine(centroids, coordinates, crs, threshold):
15341534
coordinates : 2d array
15351535
First column contains latitude, second
15361536
column contains longitude. Each row is a geographic point
1537-
unit : str
1538-
Unit to use for non-exact matching. Only possible value is "degree"
1537+
crs : pyproj crs
1538+
Coordinate reference system (crs) of the input coordinates and centroids.
15391539
threshold : float
1540-
distance threshold in km over which no neighbor will
1541-
be found. Those are assigned with a -1 index
1540+
Assignement threshold in units of the provided crs.
1541+
If the distance to the nearest neighbor exceeds `threshold`, the index `-1` is assigned.
15421542
15431543
Returns
15441544
-------
@@ -1600,11 +1600,11 @@ def _nearest_neighbor_euclidean(
16001600
coordinates : 2d array
16011601
First column contains latitude, second column contains longitude. Each
16021602
row is a geographic point
1603-
unit : str
1604-
Unit to use for non-exact matching. Possible values are "degree", "m", "km".
1603+
crs : pyproj crs
1604+
Coordinate reference system (crs) of the input coordinates and centroids.
16051605
threshold : float
1606-
distance threshold in km over which no neighbor will be found. Those
1607-
are assigned with a -1 index
1606+
Assignement threshold in units of the provided crs.
1607+
If the distance to the nearest neighbor exceeds `threshold`, the index `-1` is assigned.
16081608
check_antimedirian: bool, optional
16091609
If True, the nearest neighbor in a strip with lon size equal to threshold around the
16101610
antimeridian is recomputed using the Haversine distance. The antimeridian is guessed from

0 commit comments

Comments
 (0)