InternalApi and ApiMayChange annotations #3101
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I like this change. I think we should not use |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just like in case of Akka, I've added attribute annotations for parts of the API which are not stable (
ApiMayChange) or shouldn't be treated as public even thou they are (because of .NET limitations). Regarding latter, I've annotated only those members/types which have either public/protected/not-set encapsulation. I didn't bother to addInternalApito internal types, as this would be redundant.Those attributes could be possibly used and leveraged in future by static analysis tools to make sure users are not unintentionally using private parts of Akka.NET API.