add explicit public API definition #97
Conversation
|
|
||
| The public API that we will maintain within the constraints of our [versioning policy](./VERSIONING.rst) | ||
| consists of all public classes in the `com.amazonaws.encryptionsdk` package unless otherwise and specifically documented. | ||
|
|
There was a problem hiding this comment.
The public API that we maintain includes all public classes in the in the com.amazonaws.encryptionsdk package unless otherwise documented. Our versioning policy applies to this public API.
There was a problem hiding this comment.
Edit: "Our versioning policy applies to all public classes in the com.amazonaws.encryptionsdk
package unless otherwise documented."
There was a problem hiding this comment.
Also, not to nitpick: it also applies to public constants, methods, etc.
There was a problem hiding this comment.
... and protected methods, constants, etc.
There was a problem hiding this comment.
Second try: Our versioning policy applies to all public and protected classes/methods/fields in the com.amazonaws.encryptionsdk
package unless otherwise documented.
|
It might be helpful to include a short statement in the versioning policy, that it only applies to non-internal classes. |
Description of changes:
Adding an explicit definition of our public API to avoid confusion.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.