jaredLunde / jaredLunde/react-hook
Possible Bug based On Code Comments
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.5k
- Forks
- 96
- PR merge metrics
- No merged PRs in 30d
Description
**Describe the bug**
This isn't necessarily a bug, however I thought I would point it out in case it is unintentional.
The `useTimeoutCallback` function [here]( https://github.com/jaredLunde/react-hook/blob/84466d904a3de2cadf57681fd39598d8854e4a49/packages/timeout/src/index.tsx#L47), only has 2 parameters (`callback` and `ms`) however the code comment [here](https://github.com/jaredLunde/react-hook/blob/84466d904a3de2cadf57681fd39598d8854e4a49/packages/timeout/src/index.tsx#L35) references an additional `dependencies` parameter.
Not sure if this is a code comment that is stale or additional code that is missing.
I hope this was helpful, thanks!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read packages/timeout/src/index.tsx around the useTimeoutCallback function and its comment. Check the intended API for the callback and milliseconds parameters, then determine whether the comment or implementation is inconsistent; done means the documented parameters and actual function behavior agree.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- frontend
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100