Docs: clarify selecting fields for included relations #1008
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.
Based on Issue #959 and some other misunderstandings included in the docs, I tried to make it clearer for users to understand the deeper behavior of Spatie Query Builder when selecting fields for relationships.
Installation & setup
page with all available configuration options from the package config file.Selecting fields for included relations
section in theSelecting fields
page, and fixed its example.convert_relation_names_to_snake_case_plural
option.convert_relation_table_name_strategy
option to clarify its underlying behavior and purpose.Selecting included fields
section on theIncluding relationships
page.