mapbox / mapbox/mapbox-gl-redux
Documentation: what is the motivation for `sync`?
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 37
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
The README says
> Dispatch a MapActionCreators.sync() action at any time to give your reducer an opportunity to sync up with map state.
Naively, I would expect that my redux store would always be synced with the map state by way of reducers that responded to `MapActionTypes` with the appropriate updates to the store state. The existence of `sync` suggests to me that there are edge cases where this doesn't quite work out?
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 README passage about MapActionCreators.sync(), then inspect the reducer behavior around MapActionTypes and sync in the repository. Determine which edge cases motivate sync and update the documentation so its purpose and expected use are clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100