[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[platform-ui-dev] Request PMC approval for removal of (transitively) public method in InlineAnnotationSupprot

Dear PMC,

With https://bugs.eclipse.org/bugs/show_bug.cgi?id=532130 , we'd like to simplify and improve how iniline annotations/code minings are drawn by moving away from LineSpacingProvider.
I did merge the related patch doing so http://git.eclipse.org/c/platform/eclipse.platform.text.git/commit/?id=2d294da598154bcd7ebf63fa4dc6ae8783304be5 , but then API Tools reported that this was introducing an API breakage: http://download.eclipse.org/eclipse/downloads/drops4/I20180318-2000/apitools/freeze_report.html . API Tools is obviously right here and Dani noticed it promptly and already reverted the patch.
The initial issue comes from earlier implementation that exposed the getLineSpacing method as an inherited public member instead of using composition to hiding it. This method was introduced in M5. Although it wasn't annotated as @noreference and public, this method was never meant to be part of the API and we are not aware of anyone who's referencing it from InlineAnnotationSupport nor of any use case for which anyone would want to use it. So we feel confident that it's a safe thing to get rid of it now.

PMC, please evaluate whether changing this API is acceptable at this point and mention ASAP if and when we can re-apply the suggested patch.

Thanks in advance

--
Mickael Istria
Eclipse IDE developer, at Red Hat Developers community
Elected Committer Representative at the Eclipse Foundation board of directors