Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[api] annotate public API with @since jsdoc comment #4661

Open
2 tasks
pichlermarc opened this issue Apr 25, 2024 · 0 comments
Open
2 tasks

[api] annotate public API with @since jsdoc comment #4661

pichlermarc opened this issue Apr 25, 2024 · 0 comments
Labels
needs:code-contribution This feature/bug is ready to implement never-stale pkg:api type:feature A feature with no sub-issues to address

Comments

@pichlermarc
Copy link
Member

pichlermarc commented Apr 25, 2024

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 @since to the jsdoc of each exported public type
  • add @since to each methods and properties when they were added after the enclosing type's @since annotation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs:code-contribution This feature/bug is ready to implement never-stale pkg:api type:feature A feature with no sub-issues to address
Projects
None yet
Development

No branches or pull requests

1 participant