Fix comments according to best practices by effective go (#446)

Fix comments according to best practices by effective go

Signed-off-by: CodeLingo Bot <bot@codelingo.io>

internal/driver/cli.go

@@ -39,7 +39,7 @@ type source struct {
 	Comment      string
 }
 
-// Parse parses the command lines through the specified flags package
+// parseFlags parses the command lines through the specified flags package
 // and returns the source of the profile and optionally the command
 // for the kind of report to generate (nil for interactive use).
 func parseFlags(o *plugin.Options) (*source, []string, error) {

internal/driver/driver_test.go

@@ -530,7 +530,7 @@ func fakeDemangler(name string) string {
 	}
 }
 
-// Returns a profile with function names which should be shortened in
+// longNameFuncsProfile returns a profile with function names which should be shortened in
 // graph and flame views.
 func longNameFuncsProfile() *profile.Profile {
 	var longNameFuncsM = []*profile.Mapping{

internal/driver/interactive.go

@@ -407,7 +407,7 @@ func newCompleter(fns []string) func(string) string {
 	}
 }
 
-// matchCommand attempts to match a string token to the prefix of a Command.
+// matchVariableOrCommand attempts to match a string token to the prefix of a Command.
 func matchVariableOrCommand(v variables, token string) string {
 	token = strings.ToLower(token)
 	found := ""

internal/graph/graph_test.go

@@ -393,7 +393,7 @@ func nodeTestProfile() *profile.Profile {
 	}
 }
 
-// Check that nodes are properly created for a simple profile.
+// TestCreateNodes checks that nodes are properly created for a simple profile.
 func TestCreateNodes(t *testing.T) {
 	testProfile := nodeTestProfile()
 	wantNodeSet := NodeSet{

internal/symbolz/symbolz.go

@@ -68,7 +68,7 @@ func Symbolize(p *profile.Profile, force bool, sources plugin.MappingSources, sy
 	return nil
 }
 
-// Check whether path ends with one of the suffixes listed in
+// hasGperftoolsSuffix checks whether path ends with one of the suffixes listed in
 // pprof_remote_servers.html from the gperftools distribution
 func hasGperftoolsSuffix(path string) bool {
 	suffixes := []string{

pprof.go

@@ -53,7 +53,7 @@ func newUI() driver.UI {
 	}
 }
 
-// Read returns a line of text (a command) read from the user.
+// ReadLine returns a line of text (a command) read from the user.
 // prompt is printed before reading the command.
 func (r *readlineUI) ReadLine(prompt string) (string, error) {
 	r.rl.SetPrompt(prompt)
@@ -70,7 +70,7 @@ func (r *readlineUI) Print(args ...interface{}) {
 	fmt.Fprint(r.rl.Stderr(), text)
 }
 
-// Print shows a message to the user, colored in red for emphasis.
+// PrintErr shows a message to the user, colored in red for emphasis.
 // It is printed over stderr as stdout is reserved for regular output.
 func (r *readlineUI) PrintErr(args ...interface{}) {
 	text := fmt.Sprint(args...)
@@ -97,7 +97,7 @@ func (r *readlineUI) IsTerminal() bool {
 	return readline.IsTerminal(int(syscall.Stdout))
 }
 
-// Start a browser on interactive mode.
+// WantBrowser starts a browser on interactive mode.
 func (r *readlineUI) WantBrowser() bool {
 	return r.IsTerminal()
 }

profile/profile.go

@@ -652,7 +652,7 @@ func labelsToString(labels map[string][]string) string {
 	return strings.Join(ls, " ")
 }
 
-// numLablesToString returns a string representation of a map
+// numLabelsToString returns a string representation of a map
 // representing numeric labels.
 func numLabelsToString(numLabels map[string][]int64, numUnits map[string][]string) string {
 	ls := []string{}

profile/profile_test.go

@@ -628,7 +628,7 @@ func checkAggregation(prof *Profile, a *aggTest) error {
 	return nil
 }
 
-// Test merge leaves the main binary in place.
+// TestMergeMain tests merge leaves the main binary in place.
 func TestMergeMain(t *testing.T) {
 	prof := testProfile1.Copy()
 	p1, err := Merge([]*Profile{prof})