Merge pull request #2184 from dopplershift/interp-docs

Correct docs for search_radius in interpolate functions
Unidata · Nov 8, 2021 · bc4e869 · bc4e869
2 parents ebee96b + 9a94beb
commit bc4e869
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/src/metpy/interpolate/grid.py b/src/metpy/interpolate/grid.py
@@ -245,16 +245,16 @@ def interpolate_to_grid(x, y, z, interp_type='linear', hres=50000,
         The horizontal resolution of the generated grid, given in the same units as the
         x and y parameters. Default 50000.
     minimum_neighbors: int
-        Minimum number of neighbors needed to perform barnes or cressman interpolation for a
+        Minimum number of neighbors needed to perform Barnes or Cressman interpolation for a
         point. Default is 3.
     gamma: float
         Adjustable smoothing parameter for the barnes interpolation. Default 0.25.
     kappa_star: float
         Response parameter for barnes interpolation, specified nondimensionally
         in terms of the Nyquist. Default 5.052
     search_radius: float
-        A search radius to use for the barnes and cressman interpolation schemes.
-        If search_radius is not specified, it will default to the average spacing of
+        A search radius to use for the Barnes and Cressman interpolation schemes.
+        If search_radius is not specified, it will default to 5 times the average spacing of
         observations.
     rbf_func: str
         Specifies which function to use for Rbf interpolation.

diff --git a/src/metpy/interpolate/points.py b/src/metpy/interpolate/points.py
@@ -307,16 +307,16 @@ def interpolate_to_points(points, values, xi, interp_type='linear', minimum_neig
         2) "natural_neighbor", "barnes", or "cressman" from `metpy.interpolate`.
         Default "linear".
     minimum_neighbors: int
-        Minimum number of neighbors needed to perform barnes or cressman interpolation for a
+        Minimum number of neighbors needed to perform Barnes or Cressman interpolation for a
         point. Default is 3.
     gamma: float
         Adjustable smoothing parameter for the barnes interpolation. Default 0.25.
     kappa_star: float
         Response parameter for barnes interpolation, specified nondimensionally
         in terms of the Nyquist. Default 5.052
     search_radius: float
-        A search radius to use for the barnes and cressman interpolation schemes.
-        If search_radius is not specified, it will default to the average spacing of
+        A search radius to use for the Barnes and Cressman interpolation schemes.
+        If search_radius is not specified, it will default to 5 times the average spacing of
         observations.
     rbf_func: str
         Specifies which function to use for Rbf interpolation.