Cleaned up commets

Author: bharathi-tenneti

pkg/log/zap/flags.go

@@ -1,16 +1,21 @@
-// Copyright 2019 The Operator-SDK Authors
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
+/*
+Copyright 2019 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Package zap contains helpers for setting up a new logr.Logger instance
+// using the Zap logging framework.
 
 package zap
 

pkg/log/zap/zap.go

@@ -209,7 +209,7 @@ func NewRaw(opts ...Opts) *zap.Logger {
 	return log
 }
 
-// BindToFlagSet
+// BindToFlagSet func allows CLI passed flags to be parsed.
 func (o *Options) BindFlags(fs *pflag.FlagSet) {
 	// Set Development mode value
 	fs.BoolVar(&o.Development, "zap-devel", false, "Enable zap development mode (changes defaults to console encoder, debug log level, and disables sampling)")
@@ -237,6 +237,7 @@ func (o *Options) BindFlags(fs *pflag.FlagSet) {
 
 }
 
+// UseFlagOptions to set logger with CLI passed flags.
 func UseFlagOptions(in *Options) func(o *Options) {
 	return func(o *Options) {
 		*o = *in