Add annotations for opentelemetry-sdk
#189
Conversation
| # typed: true | ||
|
|
||
| module OpenTelemetry | ||
| sig { returns(OpenTelemetry::Trace::TracerProvider) } |
There was a problem hiding this comment.
I can see some internal usages of the SDK, I'm not familiar with OpenTelemetry but isn't it a better experience to return implementation types? For example OpenTelemetry::SDK::Trace::TracerProvider?
Example call site: OpenTelemetry.tracer_provider.shutdown
There was a problem hiding this comment.
Sure, I can do that. Would you also like me to update all the references below to be OpenTelemetry::SDK:: instead of OpenTelemetry::?
There was a problem hiding this comment.
I think so. Looks like API and SDK are 2 separate gems. This annotation is for the SDK given the name so I think it's fine to type things for the SDK specifically.
| sig { params(end_timestamp: Integer).void } | ||
| def finish(end_timestamp: nil); end |
There was a problem hiding this comment.
If the default value is nil, I think the end_timestamp should be T.nilable(Integer), no?
Type of Change
Changes