Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sezna committed Nov 11, 2024
1 parent 2650c36 commit f525342
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions library/qtest/src/Operations.qs
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@
///
/// # Input
/// ## test_cases
/// An array of three-arity tuples of the form `(test_name, callable_to_test, expected_result)`.
/// `callable_to_test` will be called and its result will be compared to `expected_result`.
/// An array of five-arity tuples of the form `(test_name, num_qubits, qubit_prep_callable, callable_to_test, expected_result)`.
/// `num_qubits` will be allocated in a qubit array and passed to `qubit_prep_callable` to prepare the state before executing
/// `callable_to_test`. Afterwards, `callable_to_test` will be called and its result will be compared to `expected_result`.
///
/// # Example
/// ```qsharp
Expand Down Expand Up @@ -58,8 +59,9 @@ operation TestCases<'Result : Eq + Show > (test_cases : (String, Int, (Qubit[])
///
/// # Input
/// ## test_cases
/// An array of three-arity tuples of the form `(test_name, callable_to_test, expected_result)`.
/// `callable_to_test` will be called and its result will be compared to `expected_result`.
/// An array of five-arity tuples of the form `(test_name, num_qubits, qubit_prep_callable, callable_to_test, expected_result)`.
/// `num_qubits` will be allocated in a qubit array and passed to `qubit_prep_callable` to prepare the state before executing
/// `callable_to_test`. Afterwards, `callable_to_test` will be called and its result will be compared to `expected_result`.
///
/// # Example
/// ```qsharp
Expand Down

0 comments on commit f525342

Please sign in to comment.