Configuration should not be internal #4376
Merged
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
Configuration
class 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
@internal
to mark a class or method for internal use, and not for internal notes that can easily be formulated in other ways.