Skip to content

Commit

Permalink
additional documentation comment
Browse files Browse the repository at this point in the history
  • Loading branch information
nr-swilloughby committed Dec 14, 2023
1 parent 865dec7 commit 932f589
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions v3/newrelic/code_level_metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,13 @@ func WithCodeLocation(loc *CodeLocation) TraceOption {
// level metrics is enabled, saving unnecessary work if those metrics
// are not enabled.
//
// If the callback function value passed here is nil, then no callback
// function will be used (same as if this function were never called).
// If the callback function itself returns nil instead of a pointer to
// a CodeLocation, then it is assumed the callback function was not able
// to determine the code location, and the CLM reporting code's normal
// method for determining the code location is used instead.
//
func WithCodeLocationCallback(locf func() *CodeLocation) TraceOption {
return func(o *traceOptSet) {
o.LocationCallback = locf
Expand Down

0 comments on commit 932f589

Please sign in to comment.