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

Already on GitHub? Sign in to your account

Adding documentation for eager-loading SQL associations. #547

Merged
merged 1 commit into from Feb 13, 2014

Conversation

Projects
None yet
2 participants
Contributor

JohnPostlethwait commented Feb 12, 2014

A nice feature which was documented in geddy/model, but not the core geddy documentation.

Contributor

mde commented Feb 12, 2014

There's a bunch of documentation about the eager-loading, but it's in a separate, SQL-only section: http://geddyjs.org/guide#ModelsMigrations%20(SQL%20adapters%20only) Does this go into enough detail?

Contributor

JohnPostlethwait commented Feb 13, 2014

Actually - looking this over again I realize I wrote the includes documentation in the wrong spot, but I feel the actual method-level-documentation should be more verbose. It was weird to have to dig down to where you linked to realize that all() takes more options than just sorting options...

Contributor

JohnPostlethwait commented Feb 13, 2014

Fixed where I talked about the "includes" option to match the style of the "sort". If you prefer I can kill the example, but I'm not sure it hurts...

@mde mde added a commit that referenced this pull request Feb 13, 2014

@mde mde Merge pull request #547 from JohnPostlethwait/master
Adding documentation for eager-loading SQL associations.
2c205f6

@mde mde merged commit 2c205f6 into geddy:master Feb 13, 2014

1 check passed

default The Travis CI build passed
Details
Contributor

mde commented Feb 13, 2014

This is great, thanks. :)

Contributor

JohnPostlethwait commented Feb 13, 2014

No problem!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment