Update JSDoc for `setFeatureState` and `removeFeatureState`
Open
Beginner friendly
Nobody has claimed this yet.
docs :scroll:
- Dominant language
- TypeScript
- Stars
- 12.4k
- Forks
- 2.4k
- PR merge metrics
- No merged PRs in 30d
Description
The documentation for setFeatureState incorrectly states that the first argument 'feature' is an Object with keys 'id', 'source', and 'sourceLayer'. It actually should be one of FeatureSelector | GeoJSONFeature | TargetFeature. Similarly, removeFeatureState documentation needs to be updated to reflect the correct argument types.
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
Search the TypeScript source for the JSDoc attached to setFeatureState and removeFeatureState. Update the documented first-argument types to FeatureSelector | GeoJSONFeature | TargetFeature, then run the repository's relevant type or documentation checks to confirm both API descriptions are corrected.
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
- 68/100