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.

Sign up for GitHub

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

Jump to bottom

Add comments for exported methods in generated controllers #1606

Closed
bvwells opened this issue Jul 22, 2020 · 1 comment · Fixed by #1690
Closed

Add comments for exported methods in generated controllers #1606

bvwells opened this issue Jul 22, 2020 · 1 comment · Fixed by #1690
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@bvwells
Copy link
Contributor

bvwells commented Jul 22, 2020

It would be great to have the exported methods in the generate controllers documented.

i.e.

// Reconcile ...
func (r *...) Reconcile(req ctrl.Request) (ctrl.Result, error) {
...

// SetupWithManager ...
func (r *...) SetupWithManager(mgr ctrl.Manager) error {
...

Would be happy to submit a PR.

/kind feature
@bvwells bvwells added the kind/feature Categorizes issue or PR as related to a new feature. label Jul 22, 2020
@camilamacedo86
Copy link
Member

Hi @bvwells,

Please, feel free to push a PR with against master. Note that we can just update/change the v3+ plugin which means that your changes in the scaffold should be performed just in : https://github.com/kubernetes-sigs/kubebuilder/tree/master/pkg/plugin/v3

@bvwells bvwells mentioned this issue Sep 22, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

✨ add comments for the exported methods in generated controllers (only v3+)
2 participants
@camilamacedo86 @bvwells