From c4b6f087e8e833fa1fab20ab82193abdb396c325 Mon Sep 17 00:00:00 2001 From: SamKarkache <93103617+SamKarkache@users.noreply.github.com> Date: Wed, 17 Apr 2024 16:14:25 -0400 Subject: [PATCH] fixed documentation to reflect bug fix --- doc/cwscope.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/cwscope.rst b/doc/cwscope.rst index 2cd4538..4033a15 100644 --- a/doc/cwscope.rst +++ b/doc/cwscope.rst @@ -40,10 +40,10 @@ higher-level API calls :type num_traces: int :param experiment_keys: A collection of keys to use for the capture of each trace. If not specified, the procedure will use the cw basic key generation `key = cw.ktp.Basic()[0]` - :type experiment_keys: np.ndarray + :type experiment_keys: list :param experiment_texts: A collection of texts to use for the capture of each trace. If not specified, the procedure will use the cw basic plaintext generation `text = cw.ktp.Basic()[1]` - :type experiment_texts: np.ndarray + :type experiment_texts: list :param fixed_key: Whether to use a fixed key for cw.ktp key generation. Ignored if a collection of keys are supplied. :type fixed_key: bool :param fixed_pt: Whether to use a fixed plaintext for cw.ktp text generation. Ignored if a collection of texts are supplied. @@ -61,13 +61,13 @@ higher-level API calls :param num_traces: The number of traces to capture for each set :type num_traces: int :param group_a_keys: An array of keys for group A - :type group_a_keys: np.ndarray + :type group_a_keys: list :param group_a_texts: An array of texts for group A - :type group_a_texts: np.ndarray + :type group_a_texts: list :param group_b_keys: An array of keys for group B - :type group_b_keys: np.ndarray + :type group_b_keys: list :param group_b_texts: An array of texts for group B - :type group_b_texts: np.ndarray + :type group_b_texts: list :param ktp: the key text pair algorithm, defaults to cwtvla.ktp.FixedVRandomText(). This is ignored if keys or texts for group A and group B are provided. :rtype: (np.ndarray, np.ndarray)