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

Improve ActiveRecord::Querying documentation [ci skip] #34562

Merged

Conversation

ruralocity
Copy link
Contributor

Summary

I had some trouble reading through API docs for ActiveRecord::Querying, so I edited them to be easier to understand.

  • Break up long sentences
  • Reword some sentences to clarify subject, predicate, and object
  • Explain drawbacks of using count_by_sql
  • Reformat documentation to 80 characters wide to improve editability

@rafaelfranca
Copy link
Member

Thank you for the pull request. Can you revert the break up of the long sentences? I don't think it make it easier to understand and just increase the overhead to review.

* Break up long sentences
* Reword some sentences to clarify subject, predicate, and object
* Explain drawbacks of using count_by_sql
@ruralocity ruralocity force-pushed the active-record-query-docs-improvement branch from 2ecf5d0 to 96f6a59 Compare November 28, 2018 22:58
@ruralocity
Copy link
Contributor Author

Thanks @rafaelfranca, I reverted the line wrapping and updated the commit message to reflect this.

@rafaelfranca rafaelfranca merged commit 89595af into rails:master Nov 28, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants