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

annotate stable apis #7071

Open
vince-fugnitto opened this issue Feb 4, 2020 · 1 comment
Open

annotate stable apis #7071

vince-fugnitto opened this issue Feb 4, 2020 · 1 comment
Assignees
Labels
quality issues related to code and application quality
Milestone

Comments

@vince-fugnitto
Copy link
Member

Description

As part of Theia v1.0.0, the code should be updated to mark stable apis with the @API annotation. This annotation will help developers recognize stable apis, and if ever updated a version update will be required.

@vince-fugnitto vince-fugnitto added the quality issues related to code and application quality label Feb 4, 2020
@vince-fugnitto vince-fugnitto added this to the Theia 1.0.0 milestone Feb 4, 2020
@akosyakov
Copy link
Member

akosyakov commented Mar 24, 2020

I'm not sure about @api annotation. In Theia is everything API. Other projects, like Node.js, defined stability index, i.e api is either unstable, stable or deprecated. I think we can rather use @stable annotation. By default all APIs is unstable meaning it can be broken, if we take care about not breaking some API or going through deprecation policy then it should be annotated as stable.

@akosyakov akosyakov changed the title api: mark stable apis with the '@API' annotation annotate stable apis Mar 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
quality issues related to code and application quality
Projects
None yet
Development

No branches or pull requests

2 participants