-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
docs: fix defaults in JSDocs to be more accurate #5196
Conversation
✅ Deploy Preview for fastidious-cascaron-4ded94 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
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.
Thanks for the PR. I think the default is actually neither true
or false
, but it depends on CI environment. There are a few more such flags:
vitest/packages/vitest/src/defaults.ts
Lines 64 to 66 in e631a63
allowOnly: !isCI, | |
isolate: true, | |
watch: !isCI, |
vitest/packages/vitest/src/defaults.ts
Line 90 in e631a63
open: !isCI, |
It looks like this behavior hasn't been documented in any of the flags, so maybe adding that note would be better.
Sounds good, I'll do that instead. |
InlineConfig.open
in JSDocsThere 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.
Wow, you went over all the default config. Thanks!
(Btw, currently CI is failing for everyone, so don't worry about that)
Thanks! As per the PR checklist, I edited your PR title.
|
Sorry about that, and thank you I appreciate it. |
Description
Fixes the defaults in JSDocs to be more accurate.
Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
pnpm-lock.yaml
unless you introduce a new test example.Tests
pnpm test:ci
.Documentation
pnpm run docs
command.Changesets
feat:
,fix:
,perf:
,docs:
, orchore:
.