enzymejs/enzyme

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

Open

#1,798 建立於 2018年8月28日

在 GitHub 查看
 (26 留言) (24 反應) (0 負責人)JavaScript (19,979 star) (2,016 fork)batch import
docshelp wanted

描述

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.

貢獻者指南

技術棧
javascriptreact
領域
testingdocumentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
needs maintainer response
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic knowledge of EnzymeReact testing experience
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
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.