docs: fix self-referential JSDoc for forEachContext param#36987
docs: fix self-referential JSDoc for forEachContext param#36987KangaZero wants to merge 1 commit into
Conversation
|
Hi @KangaZero! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
daltino
left a comment
There was a problem hiding this comment.
This PR fixes a small but notable typo in the JSDoc for the forEachContext parameter by correctly referencing it as the context for forEachFunc. The change improves the documentation clarity, aligning with React's commitment to precise and helpful comments.
Summary
The JSDoc description for the
forEachContextparameter inforEachChildrenis self-referential:```js
```
The description names the parameter in its own definition, which is meaningless.
forEachContextis the execution context (this) passed toforEachFuncwhen it is called. The siblingmapChildrenfunction (line 363) shows the correct pattern:```js
```
How did you test this change?
Documentation-only change to a JSDoc comment — no runtime behavior is affected, no tests needed. Verified by:
mapChildrenfunction's@param {*} context Context for mapFunction.description, which uses the same convention (naming the callback the context belongs to, not the parameter itself).forEachContextis passed as thethisvalue inforEachFunc.apply(this, arguments)(line 424), so "Context for forEachFunc" is factually correct.