I realize it's all over code but as I keep saying over and over on all sorts of issues, you can either use inheritdoc BY ITSELF or you can put in a documentation block. This format is not supported by the API module, our coding standards, or as far as I know any other documentation standards or docs parser.
This patch is asking for an @return to be added to SearchPage::getPlugin().
Right now it just has @inheritdoc, meaning that it will get its docs from SearchPageInterface::getPlugin(). This currently says:
/**
* Returns the search plugin.
*
* @return \Drupal\search\Plugin\SearchInterface
* The search plugin used by this search page entity.
*/
public function getPlugin();
However, in the case of a User page, which would return \Drupal\user\Plugin\Search\UserSearch, this would not be accurate -- UserSearch (currently, anyway) is not a ConfigurableSearchPluginInterface, because it has no configuration.
Comments
Comment #1
tim.plunkettThis isn't correct.
@return \Drupal\search\Plugin\SearchInterfaceis on SearchPageInterface::getPlugin().won't fix?
Comment #2
jhodgdonAnyway, you cannot do:
I realize it's all over code but as I keep saying over and over on all sorts of issues, you can either use inheritdoc BY ITSELF or you can put in a documentation block. This format is not supported by the API module, our coding standards, or as far as I know any other documentation standards or docs parser.
Comment #3
jhodgdonSo, just to clarify...
This patch is asking for an @return to be added to SearchPage::getPlugin().
Right now it just has @inheritdoc, meaning that it will get its docs from SearchPageInterface::getPlugin(). This currently says:
chx's patch proposes overriding this with
However, in the case of a User page, which would return \Drupal\user\Plugin\Search\UserSearch, this would not be accurate -- UserSearch (currently, anyway) is not a ConfigurableSearchPluginInterface, because it has no configuration.
So the proposed docs change is not accurate.