Skip to content

Docs: clarify selecting fields for included relations #1008

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

Merged
merged 2 commits into from
May 20, 2025

Conversation

amyavari
Copy link
Contributor

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.

  • Updated the Installation & setup page with all available configuration options from the package config file.
  • Added a note about default name convention for the Selecting fields for included relations section in the Selecting fields page, and fixed its example.
  • Updated the example in the explanation for the convert_relation_names_to_snake_case_plural option.
  • Updated the explanation for the convert_relation_table_name_strategy option to clarify its underlying behavior and purpose.
  • Fixed outdated references in the Selecting included fields section on the Including relationships page.

@freekmurze freekmurze merged commit ed706e8 into spatie:main May 20, 2025
1 check passed
@freekmurze
Copy link
Member

Thanks!

@amyavari amyavari deleted the docs/select-include-fields branch May 20, 2025 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants