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.