Document Option That Can Be Passed to react-test-renderer's create Function
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
Currently in the docs for TestRenderer.create, it mentions the function takes an options argument: https://reactjs.org/docs/test-renderer.html#testrenderercreate
It doesn't mention what options are actually allowed unless you scroll to the very end in a section titled "Ideas", which is not intuitive at all.
The allowed options should be documented at the create function's documentation location instead.
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 at the TestRenderer.create documentation linked in the issue and review the options currently described in the later “Ideas” section. Move or duplicate the allowed-options explanation at the create function’s documentation location, then confirm the options are discoverable there without scrolling to that section.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100