reactjs / reactjs/react.dev

useEffect documentation missing variable arryas

Open
#1,401 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
11.8k
Forks
7.9k
Avg merge
1d 11h
Merged PRs (30d)
11

Description

With colleges, we were talking about how reacts useEffect compares the input array and after diving into React code I found out that its length can't vary and didn't find the note in docs.

https://github.com/facebook/react/blob/master/packages/shared/areHookInputsEqual.js

Here's the code chunk with warning handling but it may be good to mention that in docs.

You all are awesome and I love what you are doing with React. Keep rocking 👌

Thanks also @linde12 for bouncing the ideas which led to mutual conclusion

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked packages/shared/areHookInputsEqual.js code and then locate the useEffect documentation in the React documentation site. Document that the dependency array length cannot vary, and consider the work done when the relevant useEffect guidance clearly states this constraint.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.