github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-16 07:13:53 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #38226 from MHBauer/run-options-doc-string

Browse Source 
Automatic merge from submit-queue

documentation string for DefaultExternalAddress

**What this PR does / why we need it**:
docs for a public function

**Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes #

**Special notes for your reviewer**:

**Release note**:

```release-note
NONE
```

I encountered this function that did not have a doc string. The function was easy to read, so I wrote a doc string for the function.
This commit is contained in:
Kubernetes Submit Queue 2017-01-12 16:57:37 -08:00 committed by GitHub
commit e7537a21d9
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
pkg/genericapiserver/options/server_run_options.go
View File

@ -80,6 +80,10 @@ func NewServerRunOptions() *ServerRunOptions {
}
}
// DefaultAdvertiseAddress sets the field AdvertiseAddress if
// unset. The field will be set based on the SecureServingOptions. If
// the SecureServingOptions is not present, DefaultExternalAddress
// will fall back to the insecure ServingOptions.
func (s *ServerRunOptions) DefaultAdvertiseAddress(secure *SecureServingOptions, insecure *ServingOptions) error {
if s.AdvertiseAddress == nil || s.AdvertiseAddress.IsUnspecified() {
switch {