Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
API status annotation #122
I have a need to indicate the status of API class and API methods that informs the consumers whether they are in "public", "private", "deprecated", or "beta" mode. I'd like to create a PR that introduces 'ApiStatus' annotation with the following signature:
Level: class, method
Property: public, deprecated, beta (all defaults to false)
Let me know what you think! Thanks.
I think you are mixing different concepts here: public / private belong to the "visibility" world. beta / deprecated and related stuff like alpha, RC, GA belong to the "development stage". Plus I would not add another annotation because people is already saying that there are too many annotation that make their code dirty.
So here is what I would do.
Let me know what you think and if you want to modify your pull request. Thanks.
referenced this issue
Aug 6, 2015
The task is ok, but I suggest you to wait a bit: I made a bit of refactoring in the ISSUE-127 branch so it's better to wait for me to merge it to master before implementing this. I also had to take your work and manually integrate it in the branch. I'll let you know, is it ok for you?