[Docs] add options arg to API docs for debug()

enzymejs · Jan 28, 2018 · 085e014 · 085e014
1 parent 6f7f4fb
commit 085e014
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 2 deletions.
diff --git a/docs/api/ReactWrapper/debug.md b/docs/api/ReactWrapper/debug.md
@@ -1,9 +1,14 @@
-# `.debug() => String`
+# `.debug([options]) => String`
 
 Returns an HTML-like string of the wrapper for debugging purposes. Useful to print out to the
 console when tests are not passing when you expect them to.
 
 
+#### Arguments
+
+`options` (`Object` [optional]):
+- `options.ignoreProps`: (`Boolean` [optional]): Whether props should be omitted in the resulting string. Props are included by default.
+
 #### Returns
 
 `String`: The resulting string.
@@ -72,3 +77,18 @@ Would output the following to the console:
   </div>
 </Foo>
 ```
+and:
+```jsx
+console.log(mount(<Bar id="2" />).find(Foo).debug({ ignoreProps: true }));
+```
+Would output the following to the console:
+<!-- eslint-disable -->
+```jsx
+<Foo>
+  <div>
+    <span>
+      Foo
+    </span>
+  </div>
+</Foo>
+```
diff --git a/docs/api/ShallowWrapper/debug.md b/docs/api/ShallowWrapper/debug.md
@@ -1,9 +1,14 @@
-# `.debug() => String`
+# `.debug([options]) => String`
 
 Returns an HTML-like string of the wrapper for debugging purposes. Useful to print out to the
 console when tests are not passing when you expect them to.
 
 
+#### Arguments
+
+`options` (`Object` [optional]):
+- `options.ignoreProps`: (`Boolean` [optional]): Whether props should be omitted in the resulting string. Props are included by default.
+
 #### Returns
 
 `String`: The resulting string.
@@ -55,3 +60,20 @@ Outputs to console:
  <NumberOfPages pages="633 pages" />
 </div>
 ```
+
+```jsx
+const wrapper = shallow((
+  <Book
+    title="Huckleberry Finn"
+    pages="633 pages"
+  />
+));
+console.log(wrapper.debug({ ignoreProps: true }));
+```
+Outputs to console:
+```text
+<div>
+ <h1>Huckleberry Finn</h1>
+ <NumberOfPages />
+</div>
+```