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.

Sign up for GitHub

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

Jump to bottom

Mark internal classes as @internal in PHPDocs #1931

Closed
alcaeus opened this issue Jan 15, 2019 · 3 comments
Closed

Mark internal classes as @internal in PHPDocs #1931

alcaeus opened this issue Jan 15, 2019 · 3 comments
Labels
Task
Milestone
2.0.0-RC1

Comments

@alcaeus
Copy link
Member

alcaeus commented Jan 15, 2019 •
edited
Loading

Mark classes that are internal and not covered by the BC promise as @internal via PHPDoc to let users know that they shouldn't rely on their API.

Method signatures may be changed in minor releases.
@alcaeus alcaeus added the Task label Jan 15, 2019
@alcaeus alcaeus added this to the 2.0.0-Beta2 milestone Jan 15, 2019
@malarzm
Copy link
Member

malarzm commented Jan 15, 2019

I think we could also add final to some classes like CollectionPersister or such

@alcaeus
Copy link
Member Author

alcaeus commented Jan 16, 2019

Absolutely. We can prepare that and mark them as @final in 1.3 along with deprecation notices if they're extended.

@malarzm malarzm mentioned this issue Feb 19, 2019
Merged
@malarzm
Copy link
Member

malarzm commented Mar 21, 2019

Closing as I've just opened #1984 to mark classes as final which was last thing to do in this issue (PR has a needs compat label)

@malarzm malarzm closed this as completed Mar 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Task
Projects
None yet
Milestone
2.0.0-RC1
Development

No branches or pull requests
2 participants
@alcaeus @malarzm