-
Notifications
You must be signed in to change notification settings - Fork 953
Open
Labels
needs:code-contributionThis feature/bug is ready to implementThis feature/bug is ready to implementnever-stalepkg:apitype:featureA feature with no sub-issues to addressA feature with no sub-issues to address
Description
Description
It's currently hard for instrumentation authors to define a minimum API version to depend on. Finding when a feature was added requires looking through the diff and cross-referencing the commits and associated PRs with releases across two repositories (https://github.com/open-telemetry/opentelemetry-js/releases and the now archived https://github.com/open-telemetry/opentelemetry-js-api/releases repo).
Therefore we should annotate all parts of the public API with a @since jsdoc that notes the API version that they were introduced in.
For this issue to be considered done we need to:
- add
@sinceto the jsdoc of each exported public type - add
@sinceto each methods and properties when they were added after the enclosing type's@sinceannotation
Metadata
Metadata
Assignees
Labels
needs:code-contributionThis feature/bug is ready to implementThis feature/bug is ready to implementnever-stalepkg:apitype:featureA feature with no sub-issues to addressA feature with no sub-issues to address