Configuration should not be internal#4376
Merged
morozov merged 1 commit intodoctrine:2.12.xfrom Oct 22, 2020
Merged
Conversation
greg0ire
previously approved these changes
Oct 22, 2020
Member
|
I'll retarget on 2.12.x because we are not going to have another 2.11 release |
morozov
approved these changes
Oct 22, 2020
Member
|
Thanks, @BenMorel. |
rgrellmann
pushed a commit
to Rossmann-IT/dbal
that referenced
this pull request
Mar 7, 2021
Release [2.12.0](https://github.com/doctrine/dbal/milestone/82) 2.12.0 ====== - Total issues resolved: **1** - Total pull requests resolved: **7** - Total contributors: **5** Documentation,Static Analysis ----------------------------- - [4376: Configuration should not be internal](doctrine#4376) thanks to @BenMorel CI -- - [4374: Reduce number of build jobs](doctrine#4374) thanks to @greg0ire - [4365: Fail on extension / tool installation failure](doctrine#4365) thanks to @greg0ire Bug,Static Analysis ------------------- - [4373: Psalm fails on release commits](doctrine#4373) thanks to @morozov Documentation,Error Handling ---------------------------- - [4362: Adds exception thrown by execute() method](doctrine#4362) thanks to @toby-griffiths CI,PHP ------ - [4361: Test all extensions with PHP8](doctrine#4361) thanks to @greg0ire PHP --- - [4347: &doctrine#91;2.12&doctrine#93; PHP 8 compatibility](doctrine#4347) thanks to @derrabus # gpg: Signature made Thu Oct 22 20:29:24 2020 # gpg: using DSA key 1BEDEE0A820BC30D858F9F0C2C3A645671828132 # gpg: Can't check signature: No public key
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
Configurationclass is currently marked as@internal, even though this markup was actually intended to be used as an internal note, not for marking the whole class for internal use.I think the phpdoc documentation is unclear on the subject:
But as a matter of fact, Psalm considers the class internal and reports a violation:
I think we should be on the safe side and only use
@internalto mark a class or method for internal use, and not for internal notes that can easily be formulated in other ways.