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

docs: fix defaults in JSDocs to be more accurate #5196

Merged
merged 6 commits into from
Feb 20, 2024

Conversation

aryaemami59
Copy link
Contributor

@aryaemami59 aryaemami59 commented Feb 14, 2024

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:

  • It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
  • Ideally, include a test that fails without this PR but passes with it.
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

  • Run the tests with pnpm test:ci.

Documentation

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

Copy link

netlify bot commented Feb 14, 2024

Deploy Preview for fastidious-cascaron-4ded94 ready!

Name Link
🔨 Latest commit 12df391
🔍 Latest deploy log https://app.netlify.com/sites/fastidious-cascaron-4ded94/deploys/65d46487af36ec00086579e6
😎 Deploy Preview https://deploy-preview-5196--fastidious-cascaron-4ded94.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@hi-ogawa hi-ogawa left a 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:

allowOnly: !isCI,
isolate: true,
watch: !isCI,

It looks like this behavior hasn't been documented in any of the flags, so maybe adding that note would be better.

@aryaemami59
Copy link
Contributor Author

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.

@aryaemami59 aryaemami59 marked this pull request as draft February 17, 2024 15:16
@aryaemami59 aryaemami59 changed the title Fix the default config for InlineConfig.open in JSDocs Fix defaults in JSDocs to be more accurate Feb 17, 2024
hi-ogawa
hi-ogawa previously approved these changes Feb 18, 2024
Copy link
Contributor

@hi-ogawa hi-ogawa left a 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)

packages/vitest/src/types/coverage.ts Show resolved Hide resolved
@hi-ogawa hi-ogawa changed the title Fix defaults in JSDocs to be more accurate docs: fix defaults in JSDocs to be more accurate Feb 18, 2024
@hi-ogawa
Copy link
Contributor

Thanks!

As per the PR checklist, I edited your PR title.

Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

@aryaemami59
Copy link
Contributor Author

Thanks!

As per the PR checklist, I edited your PR title.

Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

Sorry about that, and thank you I appreciate it.

@aryaemami59 aryaemami59 marked this pull request as ready for review February 18, 2024 02:15
@sheremet-va sheremet-va merged commit 2f755f0 into vitest-dev:main Feb 20, 2024
18 of 19 checks passed
@aryaemami59 aryaemami59 deleted the fix-jsdocs branch February 20, 2024 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants