From 09e80b0a06b59feb64452f09f97a51e2a90eac78 Mon Sep 17 00:00:00 2001
From: Scott Feeney <scott@oceanbase.org>
Date: Tue, 27 Jan 2015 17:09:16 -0800
Subject: [PATCH] Mention shallow rendering's limitations

Also, move it to the bottom of the test utils documentation and mention that it's experimental.
---
 docs/10.4-test-utils.md | 83 +++++++++++++++++++++--------------------
 1 file changed, 43 insertions(+), 40 deletions(-)

diff --git a/docs/10.4-test-utils.md b/docs/10.4-test-utils.md
index 0e1bdc49..7c34ee2e 100644
--- a/docs/10.4-test-utils.md
+++ b/docs/10.4-test-utils.md
@@ -8,46 +8,6 @@ next: clone-with-props.html
 
 `React.addons.TestUtils` makes it easy to test React components in the testing framework of your choice (we use [Jest](http://facebook.github.io/jest/)).
 
-## Shallow rendering
-
-Shallow rendering allows you to render a component "one level deep" and assert facts about what its render method returns, without worrying about the behavior of child components, which are not instantiated or rendered. This does not require a DOM.
-
-```javascript
-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)
-```
-
-Similar to `React.render`.
-
-```javascript
-ReactComponent shallowRenderer.getRenderOutput()
-```
-
-After render has been called, returns shallowly rendered output. You can then begin to assert facts about the output. For example, if your component's render method returns:
-
-```javascript
-<div>
-  <span className="heading">Title</span>
-  <Subcomponent foo="bar" />
-</div>
-```
-
-Then you can assert:
-
-```javascript
-result = renderer.getRenderOutput();
-expect(result.type).toBe('div');
-expect(result.props.children).toEqual([
-  <span className="heading">Title</span>
-  <Subcomponent foo="bar" />
-]);
-```
-
 ### Simulate
 
 ```javascript
@@ -170,3 +130,46 @@ ReactComponent findRenderedComponentWithType(ReactComponent tree, function compo
 ```
 
 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.
+
+
+## Shallow rendering
+
+Shallow rendering is an experimental feature that lets you render a component "one level deep" and assert facts about what its render method returns, without worrying about the behavior of child components, which are not instantiated or rendered. This does not require a DOM.
+
+```javascript
+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)
+```
+
+Similar to `React.render`.
+
+```javascript
+ReactComponent shallowRenderer.getRenderOutput()
+```
+
+After render has been called, returns shallowly rendered output. You can then begin to assert facts about the output. For example, if your component's render method returns:
+
+```javascript
+<div>
+  <span className="heading">Title</span>
+  <Subcomponent foo="bar" />
+</div>
+```
+
+Then you can assert:
+
+```javascript
+result = renderer.getRenderOutput();
+expect(result.type).toBe('div');
+expect(result.props.children).toEqual([
+  <span className="heading">Title</span>
+  <Subcomponent foo="bar" />
+]);
+```
+
+Shallow testing currently has some limitations, namely not supporting refs. We're releasing this feature early and would appreciate the React community's feedback on how it should evolve.