Skip to content

fix(docs): fix typo in packageFilter code example - #12851

Merged
SimenB merged 1 commit into
jestjs:mainfrom
limonte:fix/custom-resolver-typo
May 16, 2022
Merged

fix(docs): fix typo in packageFilter code example#12851
SimenB merged 1 commit into
jestjs:mainfrom
limonte:fix/custom-resolver-typo

Conversation

@limonte

@limonte limonte commented May 16, 2022

Copy link
Copy Markdown
Contributor

Summary

The current code example of packageFilter usage is broken and catching the typo isn't trivial without TS.

Test plan

No tests needed.

mrazauskas
mrazauskas reviewed May 16, 2022
View reviewed changes
Comment thread docs/Configuration.md Outdated

```js
module.exports = (path, options) => {
module.exports = (request, options) => {

@mrazauskas mrazauskas May 16, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Good idea. Docs above mention path, so I would leave it here as is, but would change request below. Just to keep it all in sync.

@limonte limonte May 16, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done 👍

@mrazauskas

mrazauskas commented May 16, 2022

Copy link
Copy Markdown
Contributor

Thanks! Please fix this in versioned docs as well. These live at website/versioned_docs. 28.0 and 28.1 are enough in this case.

@limonte

limonte commented May 16, 2022

Copy link
Copy Markdown
Contributor Author

Thanks! Please fix this in versioned docs as well. These live at website/versioned_docs. 28.0 and 28.1 are enough in this case.

Done 👍

@mrazauskas

mrazauskas commented May 16, 2022

Copy link
Copy Markdown
Contributor

Perfect 👍

SimenB
SimenB approved these changes May 16, 2022
View reviewed changes

@SimenB SimenB left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

thanks! can you update the other versions of this doc as well?

@limonte

limonte commented May 16, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

thanks! can you update the other versions of this doc as well?

26.x and 27.x are fine, they just consistently use request instead of path. Let me know if you want me to change the agr name to be path across all versions.

@SimenB

SimenB commented May 16, 2022

Copy link
Copy Markdown
Member

Ah, fair point 👍

@SimenB
SimenB merged commit 43d075c into jestjs:main May 16, 2022
This was referenced Jun 13, 2022
Merged
Merged
@github-actions

github-actions Bot commented Jun 16, 2022

Copy link
Copy Markdown

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.

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Jun 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@SimenB SimenB SimenB approved these changes
+1 more reviewer
@mrazauskas mrazauskas mrazauskas left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

cla signed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@limonte @mrazauskas @SimenB @facebook-github-bot