Document preconfigured eager loading - #346
Open
elpete wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #47
Issue review
Recommendation: 9/10 — document. Preconfigured eager loading is powerful but currently discoverable only by reading implementation or tests. Documenting its syntax, nested paths, query coverage, and over-fetching tradeoff makes the feature safer to adopt.
Documentation
variables._withon an entityall,get,first, andfindRepository note
The standalone
cbQuickDocsrepository currently exposes only amasterbranch. Per the requirement that every PR in this issue pass targetnext, this documentation is added to Quick’s repository README and the PR targetsnext.Validation
git diff --checkThe documented behavior is covered by the existing automatic eager-loading integration spec. Uses
qb@14.0.0-beta.3.