From: W. Trevor King <wking@tremily.us>
Date: Sun, 18 Nov 2012 22:56:35 +0000 (-0500)
Subject: FFT_tools: add docstrings to separate function args and body
X-Git-Tag: 0.4~1
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=2c2f96b2905def4871105a199c7dfee706a8be45;p=FFT-tools.git

FFT_tools: add docstrings to separate function args and body
---

diff --git a/FFT_tools.py b/FFT_tools.py
index 13fd5a0..8c864c4 100644
--- a/FFT_tools.py
+++ b/FFT_tools.py
@@ -466,6 +466,7 @@ def _gaussian2(area, mean, std, t):
 
 def _test_unitary_power_spectrum_gaussian(
     area=2.5, mean=5, std=1, samp_freq=10.24, samples=512):
+    "Test unitary_power_spectrum() on the gaussian function"
     x = _numpy.zeros((samples,), dtype=_numpy.float)
     mean = _numpy.float(mean)
     for i in range(samples):
@@ -608,6 +609,7 @@ def unitary_avg_power_spectrum(data, freq=1.0, chunk_size=2048,
 def _test_unitary_avg_power_spectrum_sin(
     sin_freq=10, samp_freq=512, samples=1024, chunk_size=512, overlap=True,
     window=window_hann):
+    "Test unitary_avg_power_spectrum() on the sine function"
     x = _numpy.zeros((samples,), dtype=_numpy.float)
     samp_freq = _numpy.float(samp_freq)
     for i in range(samples):