add docstrings compiler tests #7184
Draft
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
cknitt
reviewed
Dec 15, 2024
There was a problem hiding this comment.
Wow, thanks a lot @aspeddro, I had completely overlooked this PR!
Regarding adding assert_eq to Pervasives, I think we should use follow ReScript naming conventions rather than OCaml naming conventions, i.e., use assertEqual rather than assert_eq.
I am also wondering if all those assertions look nice enough in the doc comments / hover help in VS Code, or whether we could maybe separate them somehow so that they are executed in the tests, but not shown in hover help.
Any thoughts on that @zth?
| } | ||
| ) | ||
|
|
||
| let allErros = Array.concat(runtimeErrors, compilationErrors) |
There was a problem hiding this comment.
Suggested change
| let allErros = Array.concat(runtimeErrors, compilationErrors) | |
| let allErrors = Array.concat(runtimeErrors, compilationErrors) |
| let runtimeErrors = | ||
| (await compiled | ||
| ->Array.filter((({id}, _, _)) => !Array.includes(ignoreRuntimeTests, id)) | ||
| ->Array.map(async ((example, rescriptCode, jsCode)) => { |
There was a problem hiding this comment.
If there is too much parallelism here, you might consider a solution like in #7081.
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.
Add tests for docstrings examples
From rescript-lang/rescript-core#184
We can extend this PR to add runtime tests (rescript-lang/rescript-core#210)