Add list of arguments to correlation2spectrum doc string

qojulia · Jun 2, 2017 · 2e11724 · 2e11724
1 parent 3cdae91
commit 2e11724
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/timecorrelations.jl b/src/timecorrelations.jl
@@ -137,6 +137,11 @@ end
     timecorrelations.correlation2spectrum(tspan, corr; normalize)
 
 Calculate spectrum as Fourier transform of a correlation function with a given correlation function.
+
+# Arguments
+* `tspan`: List of time points corresponding to the correlation function.
+* `corr`: Correlation function of which the Fourier transform is to be calculated.
+* `normalize`: Specify if spectrum should be normalized to its maximum.
 """
 function correlation2spectrum{T <: Number}(tspan::Vector{Float64}, corr::Vector{T}; normalize::Bool=false)
   n = length(tspan)