From cae55dbfee4d641a55503ad61cfa098083016038 Mon Sep 17 00:00:00 2001 From: Wolfgang Kastaun <wolfgang.kastaun@aei.mpg.de> Date: Thu, 19 Dec 2024 17:57:12 +0100 Subject: [PATCH] Correct some module docstrings --- lisainstrument/fixed_shift_dask.py | 4 ++-- lisainstrument/fixed_shift_numpy.py | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/lisainstrument/fixed_shift_dask.py b/lisainstrument/fixed_shift_dask.py index 7dcc277..7ceea69 100644 --- a/lisainstrument/fixed_shift_dask.py +++ b/lisainstrument/fixed_shift_dask.py @@ -1,6 +1,6 @@ -"""Functions for applying dynamic real-valued shifts to dask arrays using Lagrange interpolation +"""Functions for applying fixed real-valued shifts to dask arrays using Lagrange interpolation -Use make_dynamic_shift_lagrange_dask to create a Lagrange interpolator for dask arrays. +Use make_fixed_shift_lagrange_dask to create a Lagrange interpolator for dask arrays. """ from __future__ import annotations diff --git a/lisainstrument/fixed_shift_numpy.py b/lisainstrument/fixed_shift_numpy.py index e0b1a9e..25a0868 100644 --- a/lisainstrument/fixed_shift_numpy.py +++ b/lisainstrument/fixed_shift_numpy.py @@ -1,8 +1,8 @@ -"""Functions for interpolating numpy arrays with 1D regularly spaced data +"""Functions for applying fixed real-valued shifts to numpy arrays using Lagrange interpolation -This provides a generic interface RegularInterpolator as well as two interpolation -methods, linear and Lagrange. The latter is written from scratch, see module -regular_interpolator_dsp for another one based on the dsp.timeshift Lagrange interpolator. +This provides a generic interface FixedShiftCore as well as an implementation using +Lagrange interpolation. The latter is written from scratch, see module +fixed_shift_dsp for another one based on the dsp.timeshift Lagrange interpolator. """ from __future__ import annotations -- GitLab