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

Field/Type descriptions from schema could be added to the generated code. #117

Open
strue36 opened this issue Mar 31, 2023 · 3 comments
Open

Comments

@strue36
Copy link
Contributor

strue36 commented Mar 31, 2023

This will presumably result in a similar discussion to this. jhnnsrs/turms#54

I've implemented this as docstrings on a local branch using similar logic to that used in turms.

@strue36
Copy link
Contributor Author

strue36 commented Mar 31, 2023

I originally thought that this is what the include_comments flag was for.

@mat-sop
Copy link
Contributor

mat-sop commented Apr 11, 2023

I think optional descriptions could be added to the generated code, but first, we should clarify the include_comments description in the readme.

@mat-sop
Copy link
Contributor

mat-sop commented Jul 21, 2023

To give more context, we're using ast to generate python code, but in this library there is no way to represent comments. So adding descriptions in form of comments is quite difficult, but we still can do it like turms - using docstrings or description= attribute.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants