Skip to content
This repository has been archived by the owner on Jul 5, 2021. It is now read-only.

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

Open
knelasevero opened this issue Nov 16, 2020 · 0 comments
Open

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

knelasevero opened this issue Nov 16, 2020 · 0 comments
Labels
backend/all documentation good first issue Good for newcomers

Comments

@knelasevero
Copy link
Contributor

knelasevero commented Nov 16, 2020 •
edited
Loading

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
amouat pushed a commit that referenced this issue May 26, 2021
@paul-the-alien
Merge pull request #136 from cnmcavoy/patch-1
4e2cb0f 
Update rbac.yaml to give the controller "create" permission on leases
@ElsaChelala ElsaChelala mentioned this issue Jun 17, 2021
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
backend/all documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@knelasevero