From f808c2243ec4849438451818268b6fc0ad25fb02 Mon Sep 17 00:00:00 2001 From: Fabian Joswig Date: Wed, 24 Nov 2021 17:29:51 +0000 Subject: [PATCH] docs: gen_correlated_data docstring improved --- pyerrors/misc.py | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/pyerrors/misc.py b/pyerrors/misc.py index aee6da37..e3bfbc33 100644 --- a/pyerrors/misc.py +++ b/pyerrors/misc.py @@ -40,12 +40,17 @@ def gen_correlated_data(means, cov, name, tau=0.5, samples=1000): Parameters ---------- - means -- list containing the mean value of each observable. - cov -- covariance matrix for the data to be geneated. - name -- ensemble name for the data to be geneated. - tau -- can either be a real number or a list with an entry for - every dataset. - samples -- number of samples to be generated for each observable. + means : list + list containing the mean value of each observable. + cov : numpy.ndarray + covariance matrix for the data to be generated. + name : str + ensemble name for the data to be geneated. + tau : float or list + can either be a real number or a list with an entry for + every dataset. + samples : int + number of samples to be generated for each observable. """ assert len(means) == cov.shape[-1]