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

Clarify use of Scheme #105

Closed
wants to merge 1 commit into from
Closed

Conversation

pmorie
Copy link
Member

@pmorie pmorie commented Aug 7, 2018

Attempts to clarify the use of Scheme, plus other miscellaneous godoc improvements.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 7, 2018
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: pmorie
To fully approve this pull request, please assign additional approvers.
We suggest the following additional approvers:

If they are not already assigned, you can assign the PR to them by writing /assign in a comment when ready.

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Aug 7, 2018
// Reconciler reconciles an object
Reconciler reconcile.Reconciler
// Reconcile is the reconciler for the type the controller manages.
Reconcile reconcile.Reconcile
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment improvement is fine but questions about code change. Do we even have Reconcile interface ? I thought the interface is Reconciler ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we used to have one, but I think it got renamed really early to Reconciler.

@pmorie
Copy link
Member Author

pmorie commented Aug 7, 2018 via email

Copy link
Contributor

@DirectXMan12 DirectXMan12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

scheme clarification looks good. minor change inline wrt Reconcile change.

might want to have an example of adding your types to a scheme elsewhere (e.g. the standard "I want the Kube scheme plus my scheme")

// Reconciler reconciles an object
Reconciler reconcile.Reconciler
// Reconcile is the reconciler for the type the controller manages.
Reconcile reconcile.Reconcile
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we used to have one, but I think it got renamed really early to Reconciler.

@pmorie
Copy link
Member Author

pmorie commented Aug 22, 2018

I haven't meant to let this rot - last couple weeks have been crazy for me. Will fix shortly.

@pwittrock
Copy link
Contributor

@pmorie Still working on this? @DirectXMan12 Maybe we can just fix it up directly through the GH UI and merge it?

@droot
Copy link
Contributor

droot commented Feb 19, 2019

This PR --> #295 improved the docs. So closing this in favor of this.

@droot droot closed this Feb 19, 2019
DirectXMan12 pushed a commit that referenced this pull request Jan 31, 2020
Cleanup kubebuilder book language
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants