feat(metadata): document BackwardCompatibleFilterDescriptionTrait as public API#8326
Merged
Merged
Conversation
…public API Drop @internal and add a class-level docblock describing the trait as the user-facing way to satisfy the legacy FilterInterface::getDescription() requirement until it is removed in 6.0. Refs TODO-filters.md §5.6, §8.
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Promotes
BackwardCompatibleFilterDescriptionTraitfrom an@internalhelper to a documented, user-facing public API. Drops the@internaltag and adds a class-level docblock describing it as the way for a filter to satisfy the legacyFilterInterface::getDescription()requirement (returns[]) until that method is removed in 6.0. No code/behavior change.Roadmap
Part of the 4.4 preparation. Spec: TODO-filters.md §5.6, §8.
Phase: 4.4 (additive — exposes an existing symbol as public, no BC break).
Test plan
getDescription('Foo') === []via an anonymous class using the trait).