add table comment to generated code #215
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Adding comment to class doc string will help IDE to provide useful hints. |
|
This needs a rebase against master, tests to cover the new functionality, and a changelog entry. |
agronholm
reviewed
Jun 10, 2025
There was a problem hiding this comment.
This PR doesn't actually add the comment back to the table metadata. Should it?
| @@ -1139,6 +1141,10 @@ def render_class_declaration(self, model: ModelClass) -> str: | |||
| ) | |||
| return f"class {model.name}({parent_class_name}):" | |||
|
|
|||
| def render_table_comment(self, model: ModelClass) -> str: | |||
| if model.table.comment: | |||
| return f'"""{model.table.comment}"""' | |||
There was a problem hiding this comment.
No wrapping for long docstrings then...?
Comment on lines
+1105
to
1106
| sections.append(comments) | ||
| # Render class variables / special declarations |
There was a problem hiding this comment.
Add a blank line after a control block ends.
Suggested change
| sections.append(comments) | |
| # Render class variables / special declarations | |
| sections.append(comments) | |
| # Render class variables / special declarations |
I have to review this PR. it's very old. I've moved it out of 3.1 for the time being , as with what little time I have left, I'd like to focus on :
We'll tackle this one in future milestones 😄 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.