github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-27 21:47:07 +00:00
Code Issues Projects Releases Wiki Activity

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

Browse Source 
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
```
This commit is contained in:
Kubernetes Submit Queue 2017-10-09 08:21:01 -07:00 committed by GitHub
commit e7c61da14f
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
pkg/controller/podautoscaler/horizontal.go
View File

@ -79,6 +79,9 @@ func UnsafeConvertToVersionVia(obj runtime.Object, externalVersion schema.GroupV
return objExt, err 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 { type HorizontalController struct {
scaleNamespacer extensionsclient.ScalesGetter scaleNamespacer extensionsclient.ScalesGetter
hpaNamespacer autoscalingclient.HorizontalPodAutoscalersGetter hpaNamespacer autoscalingclient.HorizontalPodAutoscalersGetter
@ -98,6 +101,7 @@ type HorizontalController struct {
queue workqueue.RateLimitingInterface queue workqueue.RateLimitingInterface
} }
// NewHorizontalController creates a new HorizontalController.
func NewHorizontalController( func NewHorizontalController(
evtNamespacer v1core.EventsGetter, evtNamespacer v1core.EventsGetter,
scaleNamespacer extensionsclient.ScalesGetter, scaleNamespacer extensionsclient.ScalesGetter,
@ -138,6 +142,7 @@ func NewHorizontalController(
return hpaController return hpaController
} }
// Run begins watching and syncing.
func (a *HorizontalController) Run(stopCh <-chan struct{}) { func (a *HorizontalController) Run(stopCh <-chan struct{}) {
defer utilruntime.HandleCrash() defer utilruntime.HandleCrash()
defer a.queue.ShutDown() defer a.queue.ShutDown()