Cleanup and refactor code #1
Conversation
This commit cleans up the code and improves its documentation
achilleasa
force-pushed
the
feature-polish-code
branch
from
0349b8c
to
145e23a
Compare
|
I think some of the comments above your methods need to start with the method name itself in order to be parsed by godoc correctly? https://blog.golang.org/godoc-documenting-go-code I could be wrong! |
| fmt.Printf("profile: call graph analyzed %d target(s) and detected %d locations for injecting profiler hooks\n", len(profileFuncs), len(profileTargets)) | ||
| profileTargets, err := goPackage.Find(profileFuncs...) | ||
| if err != nil { | ||
| defer util.ExitWithError(err.Error()) |
There was a problem hiding this comment.
Why is this a defer, when we immediately return in the line below?
There was a problem hiding this comment.
If you look a couple of lines above I use a defer() call to cleanup the tmp folder. So I am wrapping util.ExitWithError (basically prints and error and calls os.Exit(1)) with a defer so it executes after the cleanup code
There was a problem hiding this comment.
Oh wait... it executes in reverse order.... :-( I need to update it to use the new cli package which supports errors
|
Looks like godoc is picking up the comments correctly |
|
Gotcha! 🍰 |
No description provided.