Use Admonitions on website #12495 #12951

paulreece · 2022-06-17T20:53:54Z

Summary

I have changed all of the improperly formatted "note" sections to now use admonitions instead.

Test plan

The code is just markdown edits so I'm sure it will pass all tests.

facebook-github-bot · 2022-06-17T20:53:58Z

Hi @paulreece!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

facebook-github-bot · 2022-06-17T22:46:02Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

mrazauskas · 2022-08-20T16:17:17Z

Thanks! Could you split the PR, please?

That is rather large change and it is hard to review everything in one go.

It would be perfect to keep one file (or two smaller) per PR.

paulreece · 2022-08-20T16:21:45Z

@mrazauskas So you want me to split out each md file that I edited? Like 20 PRs? There's only a couple of changes per file, just changing the old note style to the admonition style.

mrazauskas · 2022-08-20T16:39:50Z

Right, but I would like to be able to look through the whole source of each file. Just to make sure that there will be no need to come back to these files.

I did review similar PR previously and to look through one or two file was fine. More is too much.

Also note that in the issue it was agreed to keep the PRs small.

…admonitions

mrazauskas · 2022-09-19T04:26:39Z

docs/JestObjectAPI.md

+:::
+
+:::note
+
+Note: this method was previously called `autoMockOn`. When using `babel-jest`, calls to `enableAutomock` will automatically be hoisted to the top of the code block. Use `autoMockOn` if you want to explicitly avoid this behavior.


Could you look through this file again? Seems like you are only adding new lines, which are duplicating information which already exists in the document.

I removed the new lines and duplicated messages. Please let me know if there's anything else needed to change.

mrazauskas · 2022-09-19T04:27:33Z

docs/JestObjectAPI.md

@@ -715,6 +754,56 @@ Returns the `jest` object for chaining.

 Restores all mocks back to their original value. Equivalent to calling [`.mockRestore()`](MockFunctionAPI.md#mockfnmockrestore) on every mocked function. Beware that `jest.restoreAllMocks()` only works when the mock was created with `jest.spyOn`; other mocks will require you to manually restore them.

+
+### `jest.mocked<T>(item: T, deep = false)`


jest.mocked is already documented. Why is this needed?

This is a variation on jest.mocked and was preexisting from the Docs I forked.

Since Jest 29 this method has different API. Documentation got reworked accordingly. I don’t see why outdated documentation should be added, if the goal of your PR is to add missing admonitions. That it definitely out of scope. If there are any issues with current documentation of jest.mocked, please open a separate PR.

mrazauskas · 2022-09-19T04:27:52Z

docs/JestObjectAPI.md

@@ -910,8 +999,24 @@ This function is not available when using legacy fake timers implementation.

 ### `jest.setTimeout(timeout)`

+
+Set the default timeout interval (in milliseconds) for all tests and before/after hooks in the test file. This only affects the test file from which this function is called.


Why are you adding this text?

I'm not sure why it is showing that I added it but I double checked in the main app and this is preexisting text.

mrazauskas · 2022-09-19T04:29:26Z

docs/ECMAScriptModules.md

@@ -5,6 +5,16 @@ title: ECMAScript Modules

 :::caution

+
+:::note


This is fixed now.

Removed duplicated messages

mrazauskas · 2022-09-20T04:14:22Z

docs/JestObjectAPI.md

-:::info
+
+:::note


Why note is better than info?

mrazauskas · 2022-09-20T04:14:58Z

docs/JestObjectAPI.md

-:::tip
+:::note


Why note is better than tip?

mrazauskas · 2022-09-20T04:18:10Z

docs/ECMAScriptModules.md

 :::caution

+Note that due to its experimental nature there are many bugs and missing features in Jest's implementation, both known and unknown. You should check out the [tracking issue](https://github.com/facebook/jest/issues/9430) and the [label](https://github.com/facebook/jest/labels/ES%20Modules) on the issue tracker for the latest status.
+
+:::
+
+:::note


This is already a caution block, why to split it?

SimenB · 2022-09-21T12:09:07Z

docs/CLI.md

+
+:::note
+
+ Note that if configuration files are found in the specified paths, _all_ projects specified within those configuration files will be run.


I think we can skip the "Note that" starts to all these sentences

These have been removed from all .md files that have Note admonitions.

mrazauskas

Once again I would like to suggest splitting CLI.md to a separate PR. If versioned docs would be corrected accordingly (as an example see #13284), that would become a solid PR.

docs/CLI.md

mrazauskas · 2022-09-21T15:31:29Z

docs/CLI.md

@@ -180,8 +180,11 @@ Alias: `--collectCoverage`. Indicates that test coverage information should be c

 Indicates which provider should be used to instrument code for coverage. Allowed values are `babel` (default) or `v8`.

-Note that using `v8` is considered experimental. This uses V8's builtin code coverage rather than one based on Babel. It is not as well tested, and it has also improved in the last few releases of Node. Using the latest versions of node (v14 at the time of this writing) will yield better results.
+:::note


I think this can be already removed in the latest version of the docs and stay only in older ones.

Removed it.

docs/CLI.md

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

paulreece · 2022-09-22T02:19:18Z

@SimenB @mrazauskas I split the files into separate PRs. Here ya go:

#13293
#13294
#13295
#13296
#13297
#13298
#13299
#13300
#13301
#13302
#13303
#13304
#13305
#13306
#13307
#13308
#13309
#13311

mrazauskas · 2022-09-22T06:22:01Z

Perfect! Thank you so much. This is very helpful.

I have left reviews in all the PR. Here is a couple of more general notes:

it would be perfect to use these PR to update all versions of docs. Right now you touched only the next version, the versioned docs live in website/versioned_docs. See docs: use admonition in Testing Asynchronous Code page #13284 for an example of a PR which is updating all versions of docs.
remember to run yarn lint:prettier. I fixed few issues in comments, but might be that Prettier will catch something more.

paulreece · 2022-09-23T00:53:50Z

@mrazauskas To Clarify were you all wanting admonitions in each of the files in each sub directory of website/versioned_docs?

mrazauskas · 2022-09-23T04:27:22Z

Thanks a lot for the effort. Just left comments with more details in each PR. Yesterday I was in hurry to look through everything. Hope now all is clarified.

Yes, I had in mind all sub directories of website/versioned_docs. That should make six files per PR with the similar changes in each file. Keep in mind that some notes might not exist in older docs, because some features were added later. If notes are not there, no need to add them, of course.

SimenB · 2022-09-28T06:54:27Z

Thank you both so much for taking. the time to split this up and review it! ❤️

I've been neck deep in native app development the last couple of weeks (and will for the next few as well) and haven't had the time to dedicate to going through them. So I very much appreciate the bite sized, and reviewed, PRs 👍

I think we can close this one, tho, as the others should be merged.

SimenB · 2022-09-28T06:56:28Z

Note that I'll be rolling a 29.1 version, so the remaining two (#13295 and #13310) should get an additional version before landing 🙂

paulreece · 2022-09-28T19:00:11Z

@SimenB or @mrazauskas Would it be possible for you to ping me on here when you do roll out the 29.1 versions so I can then update #13295 and #13310 accordingly? Thanks so much to @mrazauskas for taking the time to help me get these revisions ready for production!

SimenB · 2022-09-28T19:03:47Z

29.1 has been out for about 10 hours 🙂

https://github.com/facebook/jest/releases/tag/v29.1.0

paulreece · 2022-09-28T19:13:19Z

Awesome thanks!

github-actions · 2022-10-30T00:11:28Z

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.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

paulreece added 2 commits June 17, 2022 16:46

Added admonitions for all instances where necessary.

2a380ba

Added admonitions for all instances where necessary.

af23bdf

paulreece mentioned this pull request Jun 17, 2022

Use Admonitions on website #12495

Closed

facebook-github-bot added the cla signed label Jun 17, 2022

paulreece and others added 2 commits August 20, 2022 11:54

Test check

6f36c3a

Merge branch 'main' into admonitions

8ba92e7

paulreece and others added 4 commits August 22, 2022 15:44

Prettier added.

a8675b3

Merge branch 'facebook:main' into admonitions

ceabf93

Merge branch 'admonitions' of https://github.com/paulreece/jest into …

c7d2bc5

…admonitions

Merge branch 'main' into admonitions

4530b04

mrazauskas reviewed Sep 19, 2022

View reviewed changes

paulreece added 2 commits September 19, 2022 18:48

Update JestObjectAPI.md

f58214c

Removed duplicated messages

Update ECMAScriptModules.md

617202a

mrazauskas reviewed Sep 20, 2022

View reviewed changes

docs/JestObjectAPI.md Outdated

Comment on lines 476 to 480

:::info

:::note

Copy link

Contributor

mrazauskas Sep 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why note is better than info?

mrazauskas reviewed Sep 20, 2022

View reviewed changes

docs/JestObjectAPI.md Outdated

Comment on lines 120 to 119

:::tip

:::note

Copy link

Contributor

mrazauskas Sep 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why note is better than tip?

mrazauskas reviewed Sep 20, 2022

View reviewed changes

paulreece added 4 commits September 20, 2022 16:51

Update ECMAScriptModules.md

55771df

Update JestObjectAPI.md

f6cc67d

Update JestObjectAPI.md

abb67b5

Update JestObjectAPI.md

100dba1

SimenB reviewed Sep 21, 2022

View reviewed changes

paulreece and others added 3 commits September 21, 2022 11:20

Update CLI.md

967e0dc

Update CodeTransformation.md

cd03254

Removed the word 'Note' from sentence beginnings.

2f76630

mrazauskas reviewed Sep 21, 2022

View reviewed changes

paulreece and others added 4 commits September 21, 2022 20:56

Update docs/CLI.md

d1b55d4

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

Update docs/CLI.md

0807a44

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

Update docs/CLI.md

d9bb4e6

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

Update CLI.md

26aa19d

SimenB closed this Sep 28, 2022

github-actions bot locked as resolved and limited conversation to collaborators Oct 30, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use Admonitions on website #12495 #12951

Use Admonitions on website #12495 #12951

paulreece commented Jun 17, 2022

facebook-github-bot commented Jun 17, 2022

facebook-github-bot commented Jun 17, 2022

mrazauskas commented Aug 20, 2022

paulreece commented Aug 20, 2022

mrazauskas commented Aug 20, 2022

mrazauskas Sep 19, 2022

paulreece Sep 19, 2022

mrazauskas Sep 19, 2022

paulreece Sep 19, 2022

mrazauskas Sep 20, 2022

mrazauskas Sep 19, 2022

paulreece Sep 19, 2022

mrazauskas Sep 19, 2022

paulreece Sep 19, 2022

mrazauskas Sep 20, 2022

mrazauskas Sep 20, 2022

mrazauskas Sep 20, 2022

SimenB Sep 21, 2022

paulreece Sep 21, 2022

paulreece Sep 21, 2022

mrazauskas left a comment

mrazauskas Sep 21, 2022

paulreece Sep 22, 2022

paulreece commented Sep 22, 2022

mrazauskas commented Sep 22, 2022

paulreece commented Sep 23, 2022

mrazauskas commented Sep 23, 2022

SimenB commented Sep 28, 2022

SimenB commented Sep 28, 2022

paulreece commented Sep 28, 2022

SimenB commented Sep 28, 2022

paulreece commented Sep 28, 2022

github-actions bot commented Oct 30, 2022

		@@ -715,6 +754,56 @@ Returns the `jest` object for chaining.

		Restores all mocks back to their original value. Equivalent to calling [`.mockRestore()`](MockFunctionAPI.md#mockfnmockrestore) on every mocked function. Beware that `jest.restoreAllMocks()` only works when the mock was created with `jest.spyOn`; other mocks will require you to manually restore them.


		### `jest.mocked<T>(item: T, deep = false)`

		@@ -910,8 +999,24 @@ This function is not available when using legacy fake timers implementation.

		### `jest.setTimeout(timeout)`


		Set the default timeout interval (in milliseconds) for all tests and before/after hooks in the test file. This only affects the test file from which this function is called.


		:::note

		Note that if configuration files are found in the specified paths, _all_ projects specified within those configuration files will be run.

Use Admonitions on website #12495 #12951

Use Admonitions on website #12495 #12951

Conversation

paulreece commented Jun 17, 2022

Summary

Test plan

facebook-github-bot commented Jun 17, 2022

Action Required

Process

facebook-github-bot commented Jun 17, 2022

mrazauskas commented Aug 20, 2022

paulreece commented Aug 20, 2022

mrazauskas commented Aug 20, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mrazauskas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paulreece commented Sep 22, 2022

mrazauskas commented Sep 22, 2022

paulreece commented Sep 23, 2022

mrazauskas commented Sep 23, 2022

SimenB commented Sep 28, 2022

SimenB commented Sep 28, 2022

paulreece commented Sep 28, 2022

SimenB commented Sep 28, 2022

paulreece commented Sep 28, 2022

github-actions bot commented Oct 30, 2022