enzymejs/enzyme

Documentation does not make it clear when to use `.dive()` vs `.shallow()`

Open

#1798 opened on Aug 28, 2018

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

Description

Describe the bug

It's not clear to me what the differences between .dive() and .shallow() are. From the documentation, and the code, it looks like they do the same thing except that .dive() errors if the element is anything but a component. It also looks like .dive() inherits the options of the container it is called on, where .shallow() does not.

Why would one choose to use .dive() over .shallow(), or vice versa? I imagine, it .dive() is preferred over .shallow(), since it's more restrictive, but it would be nice if the documentation called that out explicitly.

Contributor guide

Tech stack
javascriptreact
Domain
testingdocumentation
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of EnzymeReact testing experience
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Examine the current Enzyme documentation for .dive() and .shallow() methods. Look at the source code comments and any existing examples. The issue requests a clearer explanation of when to use each method, emphasizing that .dive() is more restrictive and inherits options. Consider updating the API reference docs in the enzyme repository, likely in the docs folder, to add a comparison section. Review the 26 comments for any additional insights from the community.