immutable-js / immutable-js/immutable-js
Wrong example for mergeDeep method in documentation
- Dominant language
- TypeScript
- Stars
- 33k
- Forks
- 1.9k
- Avg merge
- 6d 7h
- Merged PRs (30d)
- 1
Description
### What happened
Wrong example for mergeDeep in docs. In live editor shown `merge` method which doesn't work as expected. If you run an example, output will be object with shallow merge and miscompare with expected output written in comments;
`merge(original, { x: { z: 456 }}) // { x: { y: 123, z: 456 }}`
https://facebook.github.io/immutable-js/docs/#/mergeDeep
### How to reproduce
Just run example in editor from this page https://facebook.github.io/immutable-js/docs/#/mergeDeep
And see an output.
Contributor guide
Research direction
Start at the linked Immutable.js documentation page for mergeDeep and inspect the live editor example alongside its expected output. Update the example so the demonstrated method and resulting nested object agree, then rerun the example to confirm the output matches the documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100