Skip to content

Commit 50d70e6

Browse files
committed
Update the README with some clearer wording
1 parent b17512d commit 50d70e6

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@ Flags:
9797

9898
### Ignore Check Signatures
9999

100+
This setting avoids false positives from utility functions that return spans (which are handled gracefully by callers of the function).
101+
100102
The `span.SetStatus()` and `span.RecordError()` checks warn when there is:
101103

102104
1. a path to return statement
@@ -134,6 +136,8 @@ spancheck -checks 'end,set-status,record-error' -ignore-check-signatures 'record
134136

135137
### Extra Start Span Signatures
136138

139+
This setting informs spancheck of additional Span creation functions that should be linted (besides the library defaults).
140+
137141
By default, Span creation will be tracked from calls to [(go.opentelemetry.io/otel/trace.Tracer).Start](https://github.com/open-telemetry/opentelemetry-go/blob/98b32a6c3a87fbee5d34c063b9096f416b250897/trace/trace.go#L523), [go.opencensus.io/trace.StartSpan](https://pkg.go.dev/go.opencensus.io/trace#StartSpan), or [go.opencensus.io/trace.StartSpanWithRemoteParent](https://github.com/census-instrumentation/opencensus-go/blob/v0.24.0/trace/trace_api.go#L66).
138142

139143
You can use the `-extra-start-span-signatures` flag to list additional Span creation functions. For all such functions:

0 commit comments

Comments
 (0)