Fix docstring typos in qtest #2034
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| /// final element of the tuple is the expected return value from the test case. | ||
| /// | ||
| /// # Example | ||
| /// ```qsharp | ||
| /// CheckAllTestCases([("Should return 42", () -> 42, 42)]); | ||
| /// CheckAllTestCases([("Should return 42", () => 42, 42)]); |
There was a problem hiding this comment.
this function takes a tuple with 5 args, right?
| @@ -35,13 +36,13 @@ operation CheckAllTestCases<'T : Eq + Show>(test_cases : (String, Int, (Qubit[]) | |||
| /// This is a good alternative to `CheckAllTestCases` when you want custom output based on the results of your tests, | |||
| /// or more control over how test results are rendered. | |||
| /// # Input | |||
| /// Takes a list of test cases. A test case is a tuple of `(String, () -> T, 'T)`, where | |||
| /// Takes a list of test cases. A test case is a tuple of `(String, () => 'T, 'T)`, where | |||
There was a problem hiding this comment.
It seems this needs to be updated and the corresponding example as well
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some types were slightly off in the qtest docstrings. This PR fixes them.