enzymejs/enzyme

Fix documentation for React Native

Open

#1375 opened on Nov 21, 2017

View on GitHub
 (5 comments) (16 reactions) (0 assignees)JavaScript (19,979 stars) (2,016 forks)batch import
docshelp wanted

Description

Description

The documentation instructs users to install react-native-mock, which does not work with more recent versions of react due to it's usage of a deprecated API

Proposal

I'm not really sure what the appropriate solution for this is, whether to add a footnote to the documentation regarding recent versions of react-native/react, or finding a more reliable library/solution for the problem.

Thanks for the awesome utility! You've made a lot of lives easier! :1st_place_medal:

Contributor guide

Tech stack
javascriptreactreact native
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of React NativeFamiliarity with enzyme documentation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Look into the current status of react native mock and its compatibility with recent React versions. The linked issue https://github.com/RealOrangeOne/react native mock/issues/139 indicates a deprecated API. Consider updating the documentation to either add a version warning or suggest an alternative library. The documentation file is likely at docs/guides/react native.md. Check the comments on this issue for any prior discussion or proposed solutions.