Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PDE] mark package org.eclipse.m2e.pde as internal #454

Merged
merged 1 commit into from
Dec 15, 2021

Conversation

HannesWell
Copy link
Contributor

@HannesWell HannesWell commented Dec 14, 2021

Because the only (exported) package of the org.eclipse.m2e.pde is not considered public API (as for example stated in #440 (comment)) we should mark the package as such to make users aware of that fact.
Otherwise downstream-adaptors could accidentally use the classes from that package and assume they are public API, unless they have searched in the depths of the m2e-github repo.

Since org.eclipse.m2e.pde has been released in this form already actually it is already public API, but since this happened not so long ago and adaptors are unlikely (or if it happened there is a high chance that they are still active and can adapt accordingly or complain), I propose to make an exception and mark this package as internal afterwards.

@laeubi, @mickaelistria what do you think?

@laeubi
Copy link
Member

laeubi commented Dec 15, 2021

If it makes the world better lets merge it :-)

Otherwise downstream-adaptors could accidentally use the classes from that package like public API,

A matter of fact is that people will still use these if they think its useful and simply suppress the warning (as we do in m2e, tycho, ...)

@laeubi laeubi self-requested a review December 15, 2021 05:58
@HannesWell
Copy link
Contributor Author

If it makes the world better lets merge it :-)

Otherwise downstream-adaptors could accidentally use the classes from that package like public API,

A matter of fact is that people will still use these if they think its useful and simply suppress the warning (as we do in m2e, tycho, ...)

A little bit better, I think :-)
Of course it does not prevent external usage (I admit that I also sometimes use internal API if there is no public equivalent), but at least we tried our best and made down-stream users aware of it, so they (hopefully) know the implications. Unfortunately world is not perfect.

@HannesWell HannesWell merged commit 5cbd33a into eclipse-m2e:master Dec 15, 2021
@HannesWell HannesWell deleted the pdeInternals branch December 15, 2021 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants