Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

Add :method docs for ActiveRecord::AttributeMethods::Dirty dynamic methods #51769

Closed
nhorton opened this issue May 8, 2024 · 0 comments
Closed

Comments

@nhorton
Copy link
Contributor

nhorton commented May 8, 2024

ActiveModel::Dirty has doc entries like https://api.rubyonrails.org/classes/ActiveModel/Dirty.html#method-i-2A_changed-3F for the dynamically-generated methods. https://api.rubyonrails.org/classes/ActiveRecord/AttributeMethods/Dirty.html does not have such docs, and they would be very helpful.

There is a correlated issue that the ActiveModel docs come up in web searches WAY higher than the ActiveRecord ones. I would suggest two changes to help with this for SEO and discoverability.

  1. Reference the ActiveRecord doc in the ActiveModel one so folks know it exists if they end up on ActiveModel's
  2. Add a small section on dirty tracking to one of the ActiveRecord Rails Guides. This would be a great thing in general as it is massively useful and many people don't know about it.
@rails rails locked and limited conversation to collaborators May 19, 2024
@zzak zzak converted this issue into discussion #51861 May 19, 2024

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant