Enable Documentation in Schema via Description Attribute #219
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
dstelljes
approved these changes
Jul 11, 2022
Contributor
Author
|
Thanks for the quick merge @dstelljes |
Member
|
Sure thing, this will be out with 9.1.0 in a few minutes. Thanks for the contribution! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What
Enabling the
[Description("")]attribute to be used on the classes and/or class members to populate thedocfields within the generated Avro schemaWhy
As discussed here #131 .
This is very useful for embedded documentation. The Description attribute seems like a perfect for this and it keeps code and documentation close together to avoid drifts.