add comments to exported structs and methods

This commit is contained in:
rushtehrani
2020-07-03 11:43:52 -07:00
parent 7ce8d9cdfa
commit 886e39244e

View File

@@ -13,6 +13,7 @@ import (
// database, server, etc. // database, server, etc.
type SystemConfig map[string]string type SystemConfig map[string]string
// NodePoolOption extends ParameterOption to support resourceRequirements
type NodePoolOption struct { type NodePoolOption struct {
ParameterOption ParameterOption
Resources corev1.ResourceRequirements Resources corev1.ResourceRequirements
@@ -85,6 +86,7 @@ func (s SystemConfig) NodePoolOptions() (options []*NodePoolOption, err error) {
return return
} }
// NodePoolOptionByValue returns the nodePoolOption based on a given value
func (s SystemConfig) NodePoolOptionByValue(value string) (option *NodePoolOption, err error) { func (s SystemConfig) NodePoolOptionByValue(value string) (option *NodePoolOption, err error) {
options, err := s.NodePoolOptions() options, err := s.NodePoolOptions()
if err != nil { if err != nil {