Opentelemetry-java: SDK: Javadoc since tags

Created on 23 May 2019  路  5Comments  路  Source: open-telemetry/opentelemetry-java

Related to https://github.com/open-telemetry/opentelemetry-java/pull/342#discussion_r286982773

In the API all public APIs are documented with @since javadocs.

Should we do the same in SDK? For the interfaces it does not makes much sense as the since tag is in the API and SDK will have the same version.

SDK good first issue help wanted p3 required-for-ga
Source
picture pavolloffay

Most helpful comment

We should, but maybe we should defer that until we have a stable API?

picture yurishkuro on 23 May 2019
👍2

All 5 comments

We should, but maybe we should defer that until we have a stable API?

yurishkuro picture yurishkuro on 23 May 2019
👍2

Hi! Is this issue free to pick up? I would love to work on it for a good first issue! cc - @alolita

JasonXZLiu picture JasonXZLiu on 14 Sep 2020

@JasonXZLiu Sure thing. I'll assign it to you.

jkwatson picture jkwatson on 14 Sep 2020

Was checking for good first issue, found this. But seems a fix already merged. should this be closed ?

SaberSeddik picture SaberSeddik on 26 Oct 2020

I think we'll want all of the @since tags to be set to 1.0.0, but not until we're ready for a release candidate (which is hopefully coming soon!). So, I think this should be open until then.

jkwatson picture jkwatson on 26 Oct 2020
Was this page helpful?
0 / 5 - 0 ratings

Related issues

arminru picture arminru  路  5Comments
jkwatson picture jkwatson  路  3Comments
thisthat picture thisthat  路  5Comments
Oberon00 picture Oberon00  路  3Comments
z1c0 picture z1c0  路  3Comments