ContainerSolutions / externalsecret-operator

An operator to fetch secrets from cloud services and inject them in Kubernetes
Apache License 2.0
189 stars 28 forks source link

Improve our code comments to better leverage go docs and generate documentation from it #136

Open knelasevero opened 3 years ago

knelasevero commented 3 years ago

Describe the solution you'd like Title says it. We can keep our interfaces/functions/structures/API easily documented by keeping our docs embedded to our code, exporting it from code comments with go docs.

What is the added value? Contributors can focus on writing their code and already document it in only one go.

Give us examples of the outcome