Skip to content
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

Update docs to document --no-watch #6331

Merged
merged 6 commits into from
Feb 4, 2019
Merged

Update docs to document --no-watch #6331

merged 6 commits into from
Feb 4, 2019

Conversation

ricokahler
Copy link
Contributor

@ricokahler ricokahler commented Feb 1, 2019

This is a documentation pull recommended by @mrmckeb in #6285 (comment) to let people know that --no-watch now exists.

I basically just searched for watch and test and I tried to add a bit of info here and there. I'm not a doc writer or anything and I might've missed a few spots but here ya go!


Feel free to directly edit this branch or similar. I see this PR as more of a reminder that this should be done.

Copy link
Contributor

@mrmckeb mrmckeb left a comment

Choose a reason for hiding this comment

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

Hey @ricokahler, thanks for this. A few changes here, and we'll be good to merge.

I want to keep this change as small as possible, as we do want users to be running in watch mode most of the time, and don't want them to confuse this new flag with CI=true.

CONTRIBUTING.md Outdated Show resolved Hide resolved
docusaurus/docs/getting-started.md Show resolved Hide resolved
docusaurus/docs/running-tests.md Outdated Show resolved Hide resolved
docusaurus/docs/running-tests.md Outdated Show resolved Hide resolved
docusaurus/docs/available-scripts.md Outdated Show resolved Hide resolved
docusaurus/docs/getting-started.md Outdated Show resolved Hide resolved
docusaurus/docs/running-tests.md Outdated Show resolved Hide resolved
docusaurus/docs/running-tests.md Outdated Show resolved Hide resolved
@ricokahler
Copy link
Contributor Author

@mrmckeb I've finished the changes you've requested. I also changed the configuration for "Debugging Tests in Visual Studio Code" to add this flag because that's why I wanted it in the first place lol.

Let me know if I missed anything and thanks again for the opportunity!

@ianschmitz ianschmitz added this to the 2.1.4 milestone Feb 4, 2019
@mrmckeb
Copy link
Contributor

mrmckeb commented Feb 4, 2019

Thanks @ricokahler, this looks good.

I think it would be cool if you could also create a PR to add the same here: https://jestjs.io/docs/en/troubleshooting (as they reference the same VSCode config for CRA).

If you can't, let me know and I'll do it :)

If the Jest team do come up with a way to make test debugging work better with watch mode, we can remove that from the docs.

@mrmckeb mrmckeb merged commit dea19fd into facebook:master Feb 4, 2019
@ricokahler
Copy link
Contributor Author

If you can't, let me know and I'll do it :)

@mrmckeb I'm a bit tied up at the moment so it'd be better if you could. Thanks again for the opportunity to contribute

@ricokahler ricokahler deleted the feature/no-watch_update-docs branch February 5, 2019 00:48
@mrmckeb
Copy link
Contributor

mrmckeb commented Feb 5, 2019

No problem, thanks for your time. We'll add this after the next release.

@lock lock bot locked and limited conversation to collaborators Feb 10, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants