new api for usage-section

aewallin · Apr 6, 2016 · e23cad9 · e23cad9
1 parent c2f2ad4
commit e23cad9
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/README.rst b/README.rst
@@ -97,9 +97,9 @@ Usage
     rate = 1/float(data_interval_in_s) # data rate in Hz 
     taus = [1,2,4,8,16] #  tau-values in seconds
     # fractional frequency data
-    (taus_used, adev, adeverror, adev_n) = allantools.adev(frequency=fract_freqdata, rate=rate, taus=taus)
+    (taus_used, adev, adeverror, adev_n) = allantools.adev(fract_freqdata, data_type='freq', rate=rate, taus=taus)
     # phase data
-    (taus_used, adev, adeverror, adev_n) = allantools.adev(phase=phasedata, rate=rate, taus=taus)
+    (taus_used, adev, adeverror, adev_n) = allantools.adev(phasedata, data_type='phase', rate=rate, taus=taus)
 
     # notes:
     #  - taus_used may differ from taus, if taus has a non-integer multiples