refactor(MetrologicalDataStreamMet4FoF): refine MetrologicalDataStrea…

…mMet4FoF docstring
Met4FoF · Apr 21, 2021 · 1bfc2a6 · 1bfc2a6
1 parent d0ab29a
commit 1bfc2a6
Showing 1 changed file with 3 additions and 6 deletions.
diff --git a/agentMET4FOF/metrological_streams.py b/agentMET4FOF/metrological_streams.py
@@ -62,13 +62,10 @@ def __init__(
             standard uncertainties associated with values
         time_unc : float, optional (defaults to 0)
             standard uncertainties associated with timestamps
-        exp_unc : float, optional (defaults to None)
-            expanded uncertainties associated with values
+        exp_unc : float, optional
+            expanded uncertainties associated with values. If ``exp_unc`` is given explicitly, it overrides ``value_unc`` according to ``value_unc = exp_unc / cov_factor``.
         cov_factor : float, optional (defaults to 1)
-            coverage factor associated with the expanded uncertainty
-
-        If exp_unc and cov_factor are given explicit values, they override value_unc
-        according to value_unc = exp_unc / cov_factor
+            coverage factor associated with the expanded uncertainty, only used, if ``exp_unc`` is specified
         """
         super().__init__()
         self._uncertainty_parameters: Dict