Merge pull request #52985 from mattjmcnaughton/mattjmcnaughton/improve-horizontal-documentation

Automatic merge from submit-queue. If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. Improve `horizontal.go` documentation **What this PR does / why we need it**: Resolve the remaining `golint` errors in the `pkg/controller/podautoscaler` package by improving the documentation in `horizontal.go`. Now all public methods have comments. **Special notes for your reviewer**: Re discussions in [this pr](https://github.com/kubernetes/kubernetes/pull/52238). **Release note**: ```release-note NONE ```

Merge pull request #52985 from mattjmcnaughton/mattjmcnaughton/improve-horizontal-documentation
e7c61da1 · Kubernetes Submit Queue · GitHub · a3103ec9 · fa56e879 · e7c61da1
Commit e7c61da1 authored Oct 09, 2017 by Kubernetes Submit Queue Committed by GitHub Oct 09, 2017
Hide whitespace changes
Inline Side-by-side

Showing with 5 additions and 0 deletions

horizontal.go pkg/controller/podautoscaler/horizontal.go +5 -0

No files found.
--- a/pkg/controller/podautoscaler/horizontal.go
+++ b/pkg/controller/podautoscaler/horizontal.go
@@ -79,6 +79,9 @@ func UnsafeConvertToVersionVia(obj runtime.Object, externalVersion schema.GroupV
 	return objExt, err
 }

+// HorizontalController is responsible for the synchronizing HPA objects stored
+// in the system with the actual deployments/replication controllers they
+// control.
 type HorizontalController struct {
 	scaleNamespacer extensionsclient.ScalesGetter
 	hpaNamespacer   autoscalingclient.HorizontalPodAutoscalersGetter
@@ -98,6 +101,7 @@ type HorizontalController struct {
 	queue workqueue.RateLimitingInterface
 }

+// NewHorizontalController creates a new HorizontalController.
 func NewHorizontalController(
 	evtNamespacer v1core.EventsGetter,
 	scaleNamespacer extensionsclient.ScalesGetter,
@@ -138,6 +142,7 @@ func NewHorizontalController(
 	return hpaController
 }

+// Run begins watching and syncing.
 func (a *HorizontalController) Run(stopCh <-chan struct{}) {
 	defer utilruntime.HandleCrash()
 	defer a.queue.ShutDown()