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 missing info for change
column and table comment in Guides
#44928
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it makes sense to add these. Though it might be worth modifying "the change
method supports only these migration definitions" to sound less final, in case of future missing entries like these.
When you are happy with the changes, would you mind squashing the commits?
Thanks for the guidance @jonathanhefner . I'm happier with the changes now. I was considering linking to the api docs or something. But am curious what you think. I tried to avoid blowing up the scope of this change too much. Happy to accommodate if you have better suggestions though :) |
Do you mean adding another link, in addition to the individual method links? I think it would be nice to do so, but there doesn't seem to be a definitive place to link to. Linking to |
This will ensure the guide is aligned with the doc on some things that I believe it's useful. Some folks do go for the guides more of than the api for a quick reference. Order alphabetically Co-authored-by: Jonathan Hefner <jonathan@hefner.pro> Add change colum and table comment links for reference in guide Update working so we know this list may keep changing
@jonathanhefner yes, that's what I had in mind. |
Thank you, @gumatias! 🎉 Backported to |
Add missing info for `change` column and table comment in Guides [ci-skip] (cherry picked from commit bc9fa03)
Summary
Some people (myself included) rely heavier on the guides for a quick reference more than the api docs. Thought I'd throw this one in there to see if it helps.
This will address the "adding missing information" suggestion from the guide.