JedWatson / JedWatson/react-select
Add missing declaration to CustomSelectProps.tsx example
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 28k
- Forks
- 4.1k
- PR merge metrics
- No merged PRs in 30d
Description
Re-ticketed from https://github.com/JedWatson/react-select/issues/4804#issuecomment-1030480301
The mention of type declarations is in the docs, but missing from the example, where we still use @ts-ignore. We should add this declaration to the example itself :)
(I spent a few days cycling on this, as I was operating out of the examples, and didn't quite realize how important the ts-ignore line was. This is def "user error", but I thought having it reflected in the example code might help people not trip up like me!)
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
Start with the CustomSelectProps.tsx example and compare it with the type-declaration guidance already present in the docs. Add the missing declaration to the example so users no longer need to infer its importance from the @ts-ignore line; completion is confirmed when the example reflects the documented declaration.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100