Merge pull request #1936 from AllenInstitute/bugfix/1936-butterworth-…

…sweepformula-documentation Fix butterworth documentation
AllenInstitute · Nov 7, 2023 · 422033e · 422033e
2 parents becb22e + 3c61a55
commit 422033e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/Packages/MIES/SweepFormulaHelp.ifn b/Packages/MIES/SweepFormulaHelp.ifn
diff --git a/Packages/doc/SweepFormula.rst b/Packages/doc/SweepFormula.rst
@@ -481,16 +481,17 @@ The returned data type is `SF_DATATYPE_INTEGRATE`.
 butterworth
 """""""""""
 
-The operation `butterworth` applies a butterworth filter on the given data using `FilterIIR` from Igor Pro.  The operation calculates along rows. It
-takes four arguments:
+The operation `butterworth` applies a butterworth filter on the given data
+using `FilterIIR` from Igor Pro. The operation calculates along rows. It takes
+four arguments:
 
 .. code-block:: bash
 
    butterworth(array data, variable lowPassCutoffInHz, variable highPassCutoffInHz, variable order)
 
 The first parameter `data` is intended to be used with the `data()` operation but
-can be an arbitrary numeric array. The parameters lowPassCutoffInHz and highPassCutoffInHz
-are in units of `WAVEBUILDER_MIN_SAMPINT_HZ` (200.000 Hz). The maximum value for `order` is 100.
+can be an arbitrary numeric array. The parameters lowPassCutoffInHz and
+highPassCutoffInHz must be given in Hz. The maximum value for `order` is 100.
 The operation accepts multiple data waves for the data argument.
 For this case the operation is applied on each input data wave independently and returns the same number of data waves.
 The returned data type is `SF_DATATYPE_BUTTERWORTH`.