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

SDK: Javadoc since tags #344

Closed
pavolloffay opened this issue May 23, 2019 · 7 comments
Closed

SDK: Javadoc since tags #344

pavolloffay opened this issue May 23, 2019 · 7 comments
Labels
good first issue help wanted priority:p3 Lowest priority issues and bugs. release:required-for-ga Required for 1.0 GA release SDK

Comments

@pavolloffay
Copy link
Member

Related to #342 (comment)

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.

@yurishkuro
Copy link
Member

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

@pavolloffay pavolloffay changed the title Since tags in SDK SDK: Javadoc since tags May 23, 2019
@JasonXZLiu
Copy link
Member

JasonXZLiu commented Sep 14, 2020

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

@jkwatson
Copy link
Contributor

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

@SaberSeddik
Copy link

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

@jkwatson
Copy link
Contributor

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 jkwatson added priority:p3 Lowest priority issues and bugs. release:required-for-ga Required for 1.0 GA release and removed release:after-ga labels Oct 26, 2020
@jkwatson jkwatson added this to the 1.0 milestone Jan 15, 2021
@anuraaga anuraaga removed this from the 1.0 milestone Feb 26, 2021
@anuraaga
Copy link
Contributor

We discussed adding @since tags for post-1.0 versions.

@jkwatson
Copy link
Contributor

jkwatson commented Mar 5, 2021

I think we can close this. We'll add @since tags on new APIs/methods that we add, and if it becomes important, we can retro-fit the @since tags on existing APIs.

@jkwatson jkwatson closed this as completed Mar 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue help wanted priority:p3 Lowest priority issues and bugs. release:required-for-ga Required for 1.0 GA release SDK
Projects
None yet
Development

No branches or pull requests

6 participants