feat: improve generated comments #2632
Conversation
|
@a8m just wanted to flag this for your review in case you hadn't seen it, would love to know if you have any input! |
|
Thanks for the contribution @willbicks 🙏 I'll review this later today. The CI is red - you need to run |
fb1d416 to
58fba3c
Compare
|
@a8m Thanks for the tip, I updated the relevant integration schemas to reflect this change and regenerated all the generated files. |
a8m
left a comment
There was a problem hiding this comment.
Amazing job!
I added a few small comments. Please address them and I'll merge it. Thanks <3
* replace default field comment with user comment if defined * use comments defined on edges in generated entities * add docs for comment method on edges and fields * update integration to reflect above changes
58fba3c to
cb67632
Compare
|
@a8m, I was able to push a new version that addressed your suggestions. I have a few more places where I think the comment generation functionality could be improved, so I'll be looking into those and submit some requests when I have something. Thanks for all your work in maintaining this project! |
This feature improves the comments generated for entities by improving the impact of the
.Comment("")method on fields and edges. The details and justification are described in #2580.The following changes are implemented:
.Comment("")method, that comment now replaces the default comment instead of being appended to it..Comment("")method, that comment replaces the default comment instead of being ignored..Comment("")method is added to the getting started guide, and the field and edge schema docs.Closes #2580