Re: [ANNOUNCE] Please annotate public interfaces!

2016-02-16 Thread Till Rohrmann
I think the important part about the ConfigConstants is that the values don’t change. How they are represented inside of Flink, does not really matter. It would be good if that could be verified automatically. Cheers, Till ​ On Tue, Feb 16, 2016 at 2:59 PM, Robert Metzger wrote: > Thank you for

Re: [ANNOUNCE] Please annotate public interfaces!

2016-02-16 Thread Robert Metzger
Thank you for taking care of this Fabian. I would like to bring your attention to the "ConfigConstants" class. I marked it as "@Public". My intention is to ensure that we don't change configuration parameters after the 1.0 release (this would break existing configuration files of users). The tool

Re: [ANNOUNCE] Please annotate public interfaces!

2016-02-08 Thread Fabian Hueske
I created FLINK-3366 for renaming @Experimental to @PublicEvolving and FLINK-3367 to annotate all remaining API classes with @PublicEvolving. 2016-02-08 9:57 GMT+01:00 Maximilian Michels : > Never thought about "Experimental" meaning unstable but I agree it > sounds better to use the term "Evolvi

Re: [ANNOUNCE] Please annotate public interfaces!

2016-02-08 Thread Maximilian Michels
Never thought about "Experimental" meaning unstable but I agree it sounds better to use the term "Evolving". On Sun, Feb 7, 2016 at 12:45 AM, Fabian Hueske wrote: > I agree, Experimental rather suggests unstable behavior than potentially > changing interfaces. > +1 for renaming to @PublicEvolving

Re: [ANNOUNCE] Please annotate public interfaces!

2016-02-06 Thread Fabian Hueske
I agree, Experimental rather suggests unstable behavior than potentially changing interfaces. +1 for renaming to @PublicEvolving. Other opinions on strictly annotating all public interfaces with @Public / @PublicEvolving and defaulting to @Internal for all remaining interfaces? 2016-02-06 15:27 G

Re: [ANNOUNCE] Please annotate public interfaces!

2016-02-06 Thread Stephan Ewen
What "Experimental" is really saying is "Public, but not API stable". In that sense, "Internal" is not suitable, as it suggests that a method will never be public. What would you think of renaming "Experimental" to "PublicEvolving" ? That would carry pretty much explicitly the meaning that it is

Re: [ANNOUNCE] Please annotate public interfaces!

2016-02-06 Thread Stephan Ewen
Hi! These suggestions sound good in general. I am wondering if "Experimental" is not the wrong word here, because most of the things are not experimental, but just possibly subject to slight changes (though API breaking). Experimental has the connotation that something is unstable (execution wis

Re: [ANNOUNCE] Please annotate public interfaces!

2016-02-05 Thread Fabian Hueske
Hi, @Experimental and @Internal have the class scope, because we need to be able to mark internal classes of @Public classes as experimental or internal. In some cases we annotated classes as @Public and all (or most) methods as @Experimental, to indicate that a class can be used, but its interna

Re: [ANNOUNCE] Please annotate public interfaces!

2016-02-05 Thread Maximilian Michels
Hi Robert, Thanks a lot for all the work of going through the classes. At first sight, the classes look quite well chosen. One question concerning the @Public, @Experimental, and @Internal annotations: @Public may only be used for classes or interfaces. @Experimental or @Internal are used for ma

[ANNOUNCE] Please annotate public interfaces!

2016-02-05 Thread Robert Metzger
Hi, tl;dr: we now have @Public, @Internal, @Experimental annotations. Check your stuff before the release! Fabian and I spend some time the last weeks to annotate all classes we consider to be userfacing and stable with the "*@Public*" annotation. I just pushed those changes to master. There is