-
Notifications
You must be signed in to change notification settings - Fork 5.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(test): add support for type checking documentation #10521
Merged
bartlomieju
merged 30 commits into
denoland:main
from
caspervonb:feat-add-support-for-documentation-tests
May 10, 2021
Merged
feat(test): add support for type checking documentation #10521
bartlomieju
merged 30 commits into
denoland:main
from
caspervonb:feat-add-support-for-documentation-tests
May 10, 2021
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
This reverts commit e3a0fa1.
Closed
Cut out running for now to hit the 1.10 window, will land running documentation examples in a follow up after today's release. |
bartlomieju
approved these changes
May 10, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, this is great for a first pass, we'll iterate on it after 1.10. Huge thanks Casper for picking up this PR!
bartlomieju
changed the title
feat(cli): add support for testing documentation
feat(test): add support for type checking documentation
May 10, 2021
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.
This adds support for inline documentation tests.
Blocks of code within a jsdoc/tsdoc style block comment that are encased in fenced code blocks get parsed out to individual modules, type checked (and will later be run as test programs but we cut for now that to hit the release deadline).
Example: