The previous JSDoc comment was referencing three different parameters, none of which existed.
This commit updates the comment to reference the single parameter to the function: props, and to then document the properties of the props parameter.
I noticed that the type for limit was also incorrect, from digging into the codebase I believe it is meant to be documented as being a number.
brianleroux
commented
3 years ago
The previous JSDoc comment was referencing three different parameters, none of which existed. This commit updates the comment to reference the single parameter to the function:
props, and to then document the properties of thepropsparameter. I noticed that the type forlimitwas also incorrect, from digging into the codebase I believe it is meant to be documented as being a number.I followed the documentation for documenting an object parameter with JSDoc
P.S. Begin is excellent! I am really enjoying using it 😄