Merge pull request #3609 from MikaelCarpenter/issue_3603

ISSUE-3603 Some API doc updates for ErrorPolicy, FetchPolicy, and ObservableQuery
apollographql · Jul 16, 2018 · 5e6819d · 5e6819d
2 parents 9c36894 + f7bec30
commit 5e6819d
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@
   [@hwillson](https://github.com/hwillson) in [#3644](https://github.com/apollographql/apollo-client/pull/3644)
   [@gbau](https://github.com/gbau) in [#3644](https://github.com/apollographql/apollo-client/pull/3600)  
   [@chentsulin](https://github.com/chentsulin) in [#3608](https://github.com/apollographql/apollo-client/pull/3608)  
+  [@MikaelCarpenter](https://github.com/MikaelCarpenter) in [#3609](https://github.com/apollographql/apollo-client/pull/3609)
 - Updated `graphql` `peerDependencies` to handle 14.x versions.  
   [@ivank](https://github.com/ivank) in [#3598](https://github.com/apollographql/apollo-client/pull/3598)
 

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -72,3 +72,7 @@ redirects:
     docs/react/api/react-apollo.html#graphql-mutation-options
   /docs/react/recipes/simple-example.html:
     docs/react/essentials/get-started.html
+  /docs/react/api/apollo-client.html#FetchPolicy:
+    docs/react/api/react-apollo.html#graphql-config-options-fetchPolicy
+  /docs/react/api/apollo-client.html#ErrorPolicy:
+    docs/react/api/react-apollo.html#graphql-config-options-errorPolicy
diff --git a/docs/source/api/apollo-client.md b/docs/source/api/apollo-client.md
@@ -50,6 +50,8 @@ The `ApolloClient` class is the core API for Apollo, and the one you'll need to
 
 <h2 id="ObservableQuery">ObservableQuery</h2>
 
+`ApolloClient` Observables extend the Observables implementation provided by [`zen-observable`](https://github.com/zenparsing/zen-observable). Refer to the `zen-observable` documentation for additional context and API options.
+
 {% tsapibox ObservableQuery.variables %}
 {% tsapibox ObservableQuery.result %}
 {% tsapibox ObservableQuery.currentResult %}