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

enhance(docs) Computed fields docs #2030

Merged
merged 5 commits into from Sep 21, 2020

Conversation

gmac
Copy link
Contributor

@gmac gmac commented Sep 14, 2020

This performs another pass on computed fields documentation tailored to the final implementation that got merged in #1989. Also adds a few additional general notes:

  • Computed field narrative now focuses exclusively on the core @computed behavior that assumes field dependencies are a hard requirement. The supposition of what could happen if storefronts had a local cache of data is removed for now because it conflates what computed IS doing. This supposition of the local cache scenario would be more appropriate in a dedicated section that explores the fields feature–should that establish itself as a widespread use case.

  • Mentions of "Federated" are switched to "Federation". Now that type merging is decided on the "computed" terminology, "Federation" is once more only a proper noun.

  • Adds notes about query batching options and passing dataloader options.

  • Adds notes about migrating from schema extensions to type merging.

@yaacovCR – is this a reasonable compromise with your original narrative?

TODO:

  • If this PR is a new feature, reference an issue where a consensus about the design was reached (not necessary for small changes)
  • Make sure all of the significant new logic is covered by tests
  • Rebase your changes on master so that they can be merged easily
  • Make sure all tests and linter rules pass

@changeset-bot
Copy link

changeset-bot bot commented Sep 14, 2020

💥 No Changeset

Latest commit: c320580

Merging this PR will not cause any packages to be released. If these changes should not cause updates to packages in this repo, this is fine 🙂

If these changes should be published to npm, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@gmac
Copy link
Contributor Author

gmac commented Sep 16, 2020

Added additional notes about batchingOptions and migrating from schema extensions.

@yaacovCR yaacovCR merged commit 03566c9 into ardatan:master Sep 21, 2020
@yaacovCR yaacovCR added docs Focuses on documentation changes enhancement labels Sep 21, 2020
@theguild-bot
Copy link
Collaborator

The latest changes of this PR are available as alpha in npm: 6.2.4-alpha-03566c9f.0

Quickly update your package.json by running:

npx match-version @graphql-tools 6.2.4-alpha-03566c9f.0

@gmac gmac deleted the gm-computed-fields-docs branch January 8, 2021 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Focuses on documentation changes enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants