Skip to content

Commit f525342

Browse files
committed
update docs
1 parent 2650c36 commit f525342

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

library/qtest/src/Operations.qs

+6-4
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@
1111
///
1212
/// # Input
1313
/// ## test_cases
14-
/// An array of three-arity tuples of the form `(test_name, callable_to_test, expected_result)`.
15-
/// `callable_to_test` will be called and its result will be compared to `expected_result`.
14+
/// An array of five-arity tuples of the form `(test_name, num_qubits, qubit_prep_callable, callable_to_test, expected_result)`.
15+
/// `num_qubits` will be allocated in a qubit array and passed to `qubit_prep_callable` to prepare the state before executing
16+
/// `callable_to_test`. Afterwards, `callable_to_test` will be called and its result will be compared to `expected_result`.
1617
///
1718
/// # Example
1819
/// ```qsharp
@@ -58,8 +59,9 @@ operation TestCases<'Result : Eq + Show > (test_cases : (String, Int, (Qubit[])
5859
///
5960
/// # Input
6061
/// ## test_cases
61-
/// An array of three-arity tuples of the form `(test_name, callable_to_test, expected_result)`.
62-
/// `callable_to_test` will be called and its result will be compared to `expected_result`.
62+
/// An array of five-arity tuples of the form `(test_name, num_qubits, qubit_prep_callable, callable_to_test, expected_result)`.
63+
/// `num_qubits` will be allocated in a qubit array and passed to `qubit_prep_callable` to prepare the state before executing
64+
/// `callable_to_test`. Afterwards, `callable_to_test` will be called and its result will be compared to `expected_result`.
6365
///
6466
/// # Example
6567
/// ```qsharp

0 commit comments

Comments
 (0)