enzymejs/enzyme

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

Open

#1.798 geöffnet am 28. Aug. 2018

Auf GitHub ansehen
 (26 Kommentare) (24 Reaktionen) (0 zugewiesene Personen)JavaScript (19.979 Stars) (2.016 Forks)batch import
docshelp wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
needs maintainer response
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
basic knowledge of EnzymeReact testing experience
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80
Research-Richtung
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.