Comment on internal interfaces #294
Conversation
moolitayer
force-pushed
the
warn_internal_interface
branch
from
2710cc5 to
b015dfb
Compare
|
Why is there a need to place those comments? Wont it be hard to maintain them? |
There was a problem hiding this comment.
@abonas Having reviewed many PRs recently for "is this safe for 2.x or is it breaking change to API", I feel it's not clear enough to users what's considered "public API of kubeclient".
I don't know yet if this is best way to mark/document this. Suggestions very welcome...
lib/kubeclient/http_error.rb
Outdated
| @@ -18,6 +19,7 @@ def to_s | |||
| end | |||
| end | |||
|
|
|||
| # Note: this IS NOT(!) a supported interface, and might change without a version bump | |||
There was a problem hiding this comment.
why? what are people supposed to do? they need to know what exceptions to expect from us.
lib/kubeclient/watch_stream.rb
Outdated
| @@ -3,6 +3,7 @@ | |||
| module Kubeclient | |||
| module Common | |||
| # HTTP Stream used to watch changes on entities | |||
| # Note: this IS NOT(!) a supported interface, and might change without a version bump | |||
There was a problem hiding this comment.
I think only WatchStream.new is internal here. This is an object users get back from .watch_pods etc., and .watch and .finish are methods users interact with, both mentioned in README I think.
|
I'd prefer to close this one |
moolitayer
force-pushed
the
warn_internal_interface
branch
from
b015dfb to
b08efd9
Compare
|
Thanks for the analysis. Agreed. |
No description provided.