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

Enable Documentation in Schema via Description Attribute #219

Merged
merged 2 commits into from
Jul 11, 2022
Merged

Enable Documentation in Schema via Description Attribute #219

merged 2 commits into from
Jul 11, 2022

Conversation

thomasbrueggemann
Copy link
Contributor

What

Enabling the [Description("")] attribute to be used on the classes and/or class members to populate the doc fields within the generated Avro schema

Why

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.

@dstelljes dstelljes merged commit c3b346f into ch-robinson:main Jul 11, 2022
@thomasbrueggemann
Copy link
Contributor Author

Thanks for the quick merge @dstelljes
Any chance you could release this in a minor or patch version?

@dstelljes
Copy link
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants