From c5b2e40b015970e37315cf8b0199880708b69c17 Mon Sep 17 00:00:00 2001 From: Michael Clerx Date: Wed, 15 Oct 2025 22:06:28 +0100 Subject: [PATCH] Corrected get_onboard_QC_values docstring to include sweeps. --- syncropatch_export/trace.py | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/syncropatch_export/trace.py b/syncropatch_export/trace.py index cb144a6..23b6ad3 100644 --- a/syncropatch_export/trace.py +++ b/syncropatch_export/trace.py @@ -274,10 +274,16 @@ def get_onboard_QC_values(self, sweeps=None): """ Return the quality control values Rseal, Cslow (Cm), and Rseries. + Args: + sweeps (list): A list of sweep indexes to return, e.g. + ``[0, 1, 2]``. If left at its default value ``None``, data for all + sweeps will be returned. + Returns: - A dict mapping well names ('A01' up to 'P24') to tuples - ``(R_seal, Cm, R_series)`` containing the seal resistance, membrane - capacitance, and series resistance. + A dict mapping well names ('A01' up to 'P24') to lists of tuples + (one tuple per sweep), where each tuple ``(R_seal, Cm, R_series)`` + provides the seal resistance, membrane capacitance, and series + resistance. """