-
Notifications
You must be signed in to change notification settings - Fork 97
startChildSpan
with SpanOptions
interface only.
#521
startChildSpan
with SpanOptions
interface only.
#521
Conversation
/cc @hekike FYI. |
Codecov Report
@@ Coverage Diff @@
## master #521 +/- ##
==========================================
- Coverage 95.27% 94.75% -0.52%
==========================================
Files 147 147
Lines 10808 10491 -317
Branches 907 911 +4
==========================================
- Hits 10297 9941 -356
- Misses 511 550 +39
Continue to review full report at Codecov.
|
@@ -184,25 +184,12 @@ export class NoRecordSpan implements types.Span { | |||
|
|||
/** | |||
* Starts a new no record child span in the no record root span. | |||
* @param nameOrOptions Span name string or SpanOptions object. | |||
* @param kind Span kind if not using SpanOptions object. | |||
* @param [options] A SpanOptions object to start a child span. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the role of the brackets [ ] around options
in the JSDoc? Does that signify that it's optional?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, brackets are used to indicate optional param.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for cleaning it up!
Should we add these to the changelog update? |
I thought about it, but as this is an internal interface change I didn't include in CHANGELOG. WDYT? |
Hmm, technically you can require |
Yeah, this is a valid point. I will update the CHAGELOG. Thanks |
Continuation of #484, this PR is to cleanup and match internal interfaces with top level APIs. i.e. Internal
startChildSpan
interface accepts same argument(SpanOptions
) as public facing Tracer'sstartChildSpan
.This PR does not contain any breaking change.