Minor docs updates for the migration guides #1116
Conversation
Pull Request Test Coverage Report for Build 7978235888Details
💛 - Coveralls |
|
Added a PR. #1116 After looking again, I'm not sure the PR template needs any changes. It would be nice if there was a way for VSCode to dump the effective settings for |
README.md
Outdated
| @@ -444,7 +444,7 @@ The extension also features built-in conflict detection and quick fixes to assis | |||
| "clearOnRun": "terminal" | |||
| } | |||
| ``` | |||
|
|
|||
| **Migration Guide** | |||
| <a id="outputconfig-migration"></a> | |||
There was a problem hiding this comment.
Let's put the tag above the title
There was a problem hiding this comment.
Moved the anchor tag.
At first I misunderstood, thinking you wanted an alert there. Do you want to keep the alert?
There was a problem hiding this comment.
I was suggesting a simple swap like this:
<a id="outputconfig-migration"></a>
**Migration Guide**
No need for additional alert
pmcelhaney
force-pushed
the
migration-guide-fixes
branch
from
c399e71 to
0fa3e69
Compare
pmcelhaney
force-pushed
the
migration-guide-fixes
branch
from
0fa3e69 to
e116a40
Compare
| - Finally, remove any deprecated settings. | ||
|
|
||
| By following these guidelines, you should be able to smoothly transition to using `"jest.outputConfig"`. | ||
| > [!NOTE] |
There was a problem hiding this comment.
I don't think we need the [!NOTE] here. Sorry if my earlier message didn't come across clearly.
There was a problem hiding this comment.
This is pretty minor, never mind. I can adjust it later if needed.
There was a problem hiding this comment.
Yeah that's what I thought you meant at first. I was on the fence about whether the note makes it better or worse so I left it up to you.
The length of the README is getting unwieldy. If it sounds good to you, I might start sending PRs to break it up.
| - Finally, remove any deprecated settings. | ||
|
|
||
| By following these guidelines, you should be able to smoothly transition to using `"jest.outputConfig"`. | ||
| > [!NOTE] |
There was a problem hiding this comment.
This is pretty minor, never mind. I can adjust it later if needed.
Yes, the README is getting pretty hard to go through. I am interested in hearing your idea of improving it... |
The main change is to updating the migration for
autoRevealOutputto point tooutputConfiginstead ofrunMode.I also updated the formatting to use alerts syntax. If you don't like it, I'm happy to update the PR.