- Merge request !12Issue #3281977: ConfigProviderInterface::addConfigToCreate() @return annotation is wrong → (Open) created by joegraduate
- 🇺🇸United States joegraduate Arizona, USA
Was addressed in 📌 GitLabCI: Fix existing PHPCS issues Active
The PHPDoc @return annotation for the addConfigToCreate() method of the ConfigProviderInterface indicates that implementations should return "An array of configuration data read from the source storage keyed by the configuration object name." however when the addConfigToCreate() method of ConfigProvider Plugins is actually called, it is only used to manipulate the $config_to_create parameter which is passed by reference.
https://git.drupalcode.org/project/config_provider/-/blob/8.x-2.x/src/Co...
This is problematic when using static code analysis tools like phpstan because ConfigProvider Plugins will be expected to provide a return value in their addConfigToCreate() method implementations even though doing so is counter productive.
The PHPDoc @return annotation should be removed from the interface.
Create patch, review, commit.
None.
The ConfigProviderInterface::addConfigToCreate() method will properly document that implementations do not need to return anything.
None.
Needs review
3.0
Code
Not all content is available!
It's likely this issue predates Contrib.social: some issue and comment data are missing.
Was addressed in 📌 GitLabCI: Fix existing PHPCS issues Active