feat: improve generated comments #2632
Merged
Conversation
This file contains 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
|
@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 |
willbicks
force-pushed
the
feat/improve-generated-comments
branch
from
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
approved these changes
Jun 12, 2022
* 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
willbicks
force-pushed
the
feat/improve-generated-comments
branch
from
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! |
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.
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