docs: use TypeScript Examples Note partial #13212
Merged
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
mrazauskas
commented
Sep 3, 2022
| @@ -994,6 +988,8 @@ For simplicity `test.each` is picked for the examples, but the type inference is | |||
| The array of objects API is most verbose, but it makes the type inference a painless task. A `table` can be inlined: | |||
|
|
|||
| ```ts | |||
| import {test} from '@jest/globals'; | |||
There was a problem hiding this comment.
Similar to MockFunctionApi docs – note at the top and explicit imports in TypeScript Usage sections.
Comment on lines
+8
to
+10
| import TypeScriptExamplesNote from './_TypeScriptExamplesNote.md'; | ||
|
|
||
| <TypeScriptExamplesNote /> |
There was a problem hiding this comment.
Here it is about jest.mocked and jest.Mocked. Just in case, because these two currently differ from @types/jest.
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
Seems like it is time to refactor "TypeScript example will work..." note to a partial. Will be easier to maintain it this way.
(Docusaurus is so smart!)
Test plan
Deploy preview.