search

ch-robinson / dotnet-avro

An Avro implementation for .NET
https://engineering.chrobinson.com/dotnet-avro/
MIT License
134 stars 49 forks source link

Enable Documentation in Schema via Description Attribute #219

Closed thomasbrueggemann closed 2 years ago

thomasbrueggemann commented 2 years ago

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.

thomasbrueggemann commented 2 years ago

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

dstelljes commented 2 years ago

Sure thing, this will be out with 9.1.0 in a few minutes. Thanks for the contribution!