Merge pull request facebook#4724 from AnSavvides/test-util-readability

zpao · zpao · commit 80dd480a4777 · 2015-09-10T10:00:52.000-07:00
Make definitions more readable & optional params more obvious (cherry picked from commit 77703db)
diff --git a/docs/docs/10.4-test-utils.md b/docs/docs/10.4-test-utils.md
@@ -11,7 +11,10 @@ next: clone-with-props.html
 ### Simulate
 
 ```javascript
-Simulate.{eventName}(DOMElement element, object eventData)
+Simulate.{eventName}(
+  DOMElement element,
+  [object eventData]
+)
 ```
 
 Simulate an event dispatch on a DOM node with optional `eventData` event data. **This is possibly the single most useful utility in `ReactTestUtils`.**
@@ -39,111 +42,147 @@ React.addons.TestUtils.Simulate.keyDown(node, {key: "Enter", keyCode: 13, which:
 ### renderIntoDocument
 
 ```javascript
-ReactComponent renderIntoDocument(ReactElement instance)
+ReactComponent renderIntoDocument(
+  ReactElement instance
+)
 ```
 
 Render a component into a detached DOM node in the document. **This function requires a DOM.**
 
 ### mockComponent
 
 ```javascript
-object mockComponent(function componentClass, string? mockTagName)
+object mockComponent(
+  function componentClass,
+  [string mockTagName]
+)
 ```
 
 Pass a mocked component module to this method to augment it with useful methods that allow it to be used as a dummy React component. Instead of rendering as usual, the component will become a simple `<div>` (or other tag if `mockTagName` is provided) containing any provided children.
 
 ### isElement
 
 ```javascript
-boolean isElement(ReactElement element)
+boolean isElement(
+  ReactElement element
+)
 ```
 
 Returns `true` if `element` is any ReactElement.
 
 ### isElementOfType
 
 ```javascript
-boolean isElementOfType(ReactElement element, function componentClass)
+boolean isElementOfType(
+  ReactElement element,
+  function componentClass
+)
 ```
 
 Returns `true` if `element` is a ReactElement whose type is of a React `componentClass`.
 
 ### isDOMComponent
 
 ```javascript
-boolean isDOMComponent(ReactComponent instance)
+boolean isDOMComponent(
+  ReactComponent instance
+)
 ```
 
 Returns `true` if `instance` is a DOM component (such as a `<div>` or `<span>`).
 
 ### isCompositeComponent
 
 ```javascript
-boolean isCompositeComponent(ReactComponent instance)`
+boolean isCompositeComponent(
+  ReactComponent instance
+)
 ```
 
 Returns `true` if `instance` is a composite component (created with `React.createClass()`).
 
 ### isCompositeComponentWithType
 
 ```javascript
-boolean isCompositeComponentWithType(ReactComponent instance, function componentClass)
+boolean isCompositeComponentWithType(
+  ReactComponent instance,
+  function componentClass
+)
 ```
 
 Returns `true` if `instance` is a composite component (created with `React.createClass()`) whose type is of a React `componentClass`.
 
 ### findAllInRenderedTree
 
 ```javascript
-array findAllInRenderedTree(ReactComponent tree, function test)
+array findAllInRenderedTree(
+  ReactComponent tree,
+  function test
+)
 ```
 
 Traverse all components in `tree` and accumulate all components where `test(component)` is `true`. This is not that useful on its own, but it's used as a primitive for other test utils.
 
 ### scryRenderedDOMComponentsWithClass
 
 ```javascript
-array scryRenderedDOMComponentsWithClass(ReactComponent tree, string className)
+array scryRenderedDOMComponentsWithClass(
+  ReactComponent tree, string className
+)
 ```
 
 Finds all instances of components in the rendered tree that are DOM components with the class name matching `className`.
 
 ### findRenderedDOMComponentWithClass
 
 ```javascript
-ReactComponent findRenderedDOMComponentWithClass(ReactComponent tree, string className)
+ReactComponent findRenderedDOMComponentWithClass(
+  ReactComponent tree,
+  string className
+)
 ```
 
 Like `scryRenderedDOMComponentsWithClass()` but expects there to be one result, and returns that one result, or throws exception if there is any other number of matches besides one.
 
 ### scryRenderedDOMComponentsWithTag
 
 ```javascript
-array scryRenderedDOMComponentsWithTag(ReactComponent tree, string tagName)
+array scryRenderedDOMComponentsWithTag(
+  ReactComponent tree,
+  string tagName
+)
 ```
 
 Finds all instances of components in the rendered tree that are DOM components with the tag name matching `tagName`.
 
 ### findRenderedDOMComponentWithTag
 
 ```javascript
-ReactComponent findRenderedDOMComponentWithTag(ReactComponent tree, string tagName)
+ReactComponent findRenderedDOMComponentWithTag(
+  ReactComponent tree,
+  string tagName
+)
 ```
 
 Like `scryRenderedDOMComponentsWithTag()` but expects there to be one result, and returns that one result, or throws exception if there is any other number of matches besides one.
 
 ### scryRenderedComponentsWithType
 
 ```javascript
-array scryRenderedComponentsWithType(ReactComponent tree, function componentClass)
+array scryRenderedComponentsWithType(
+  ReactComponent tree,
+  function componentClass
+)
 ```
 
 Finds all instances of components with type equal to `componentClass`.
 
 ### findRenderedComponentWithType
 
 ```javascript
-ReactComponent findRenderedComponentWithType(ReactComponent tree, function componentClass)
+ReactComponent findRenderedComponentWithType(
+  ReactComponent tree, function componentClass
+)
 ```
 
 Same as `scryRenderedComponentsWithType()` but expects there to be one result and returns that one result, or throws exception if there is any other number of matches besides one.
@@ -160,7 +199,9 @@ ReactShallowRenderer createRenderer()
 Call this in your tests to create a shallow renderer. You can think of this as a "place" to render the component you're testing, where it can respond to events and update itself.
 
 ```javascript
-shallowRenderer.render(ReactElement element)
+shallowRenderer.render(
+  ReactElement element
+)
 ```
 
 Similar to `React.render`.
