Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ISSUE-3603 Some API doc updates for ErrorPolicy, FetchPolicy, and ObservableQuery #3609

Merged
merged 4 commits into from
Jul 16, 2018

Conversation

MikaelCarpenter
Copy link

@MikaelCarpenter MikaelCarpenter commented Jun 22, 2018

References

What

  • Ensure the current links for ErrorPolicy and FetchPolicy work
    • currently the ApolloClient docs try to link to these policies via {@link FetchPolicy} in watchQueryOptions.ts
    • there is currently no place under the ApolloClient docs that describe these policies. Instead, they're described in the ReactApollo docs
    • my initial solution is to add a redirect in docs/_config.yml that will take you from the ApolloClient docs to ReactApollo docs.
  • Add a mention of zen-observable to the ObservableQuery docs
    • I'm not sure how much info should be added here. So all I really do is add a link to the repo directly enderneath the ObservableQuery header.

Why

There were some comments in Slack that pointed out an issue with the links and the fact that knowing about extending zen-observable could be helpful.

Fixes #3603.

… the current error/fetch policy links work.
@ghost ghost added the 📝 documentation label Jun 22, 2018
@MikaelCarpenter
Copy link
Author

It looks like there was a timeout during the install-npm step in circleci. If anyone has any info on why that might be, let me know!

Copy link
Member

@hwillson hwillson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks very much @MikaelCarpenter - LGTM!

@hwillson hwillson merged commit 5e6819d into apollographql:master Jul 16, 2018
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API doc issues
2 participants