enzymejs/enzyme

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

Open

#1,798 opened on 2018年8月28日

GitHub で見る
 (26 comments) (24 reactions) (0 assignees)JavaScript (19,979 stars) (2,016 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.
Documentation does not make it clear when to use `.dive()` vs `.shallow()` · enzymejs/enzyme#1798 | Good First Issue