✨ Add field-level db comments when a field description exists

[iloveitaly]

This PR fixes #492 (comment) by adding column-level db comments
when a field description exists.

I can add some tests if this is the sort of PR that would be accepted.

I've implemented this in my SQLModel extension here: https://github.com/iloveitaly/activemodel/blob/master/activemodel/get_column_from_field_patch.py

Details:

• feat: pull field descriptions into db comments
• docs: document autostring
• feat: add use_attribute_docstrings pydantic config for improved docstrings

[svlandeg]

Hi, thanks for the contribution!

There are some linting errors and test failures - could you look into those? It will facilitate the review process if the CI is green. I'll go ahead and put this PR in draft in the meantime 🙏

[iloveitaly]

@svlandeg awesome, will work on CI and we can go from there! Is there anything else that I should work on in order to get this merged?

[svlandeg]

@svlandeg awesome, will work on CI and we can go from there! Is there anything else that I should work on in order to get this merged?

A test case is always useful, as it helps the reviewer as well to quickly run a small example. And it'll likely be necessary anyway to get the test coverage back to 100% (ensuring that all code in the code base gets tested).

[iloveitaly]

Awesome, I should have some time to help there. I have a bunch of other SQLModel improvements I'd love to pull over from activemodel, so understanding the best contribution flow would be really helpful

[svlandeg]

Awesome, I should have some time to help there. I have a bunch of other SQLModel improvements I'd love to pull over from activemodel, so understanding the best contribution flow would be really helpful

Sure thing, let me know if you have specific questions/doubts about contributing to sqlmodel, happy to provide guidance if needed!

[morigs]

Hi, looking forward to this feature. Do you have plans on finishing it?

[github-actions]

Heads-up: this will be closed in 3 days unless there's new activity.

[iloveitaly]

Friendly reminder about this pull request! Let me know if there are any further updates needed.

[svlandeg]

Friendly reminder about this pull request! Let me know if there are any further updates needed.

There are unresolved conflicts and in February 2025 you said you would look into the tests and the coverage. The CI has been red and has been waiting for action from you since (cf conversation ☝️ )

[iloveitaly]

@svlandeg ah, right! I'll fix that up.