- Issue created by @joachim
- First commit to issue fork.
- Merge request !176Issue #3451538: Clarify that $datasource_id refers to datasource plugin ID in PHPDoc ā (Open) created by maneesha binish
- š¦š¹Austria drunken monkey Vienna, Austria
Thanks for creating this MR!
However, I see that the code already specifies everywhere (except forremoveDatasource()
, admittedly ā funnily, that is the one method not mentioned in the issue title) that$datasource_id
is a datasource plugin ID, in exactly those words. Therefore, I struggle to see what value these additional sentences provide. Iād very much like input from others before merging this.One real problem I see in that area, though, which is not addressed by this issue is that
setDatasources()
apparently requires the$datasources
array to be keyed by the datasource plugin IDs without specifiying this in the documentation.
Therefore we should either fix the documentation, or the code. (I think this would have blown up if anyone would have used this incorrectly so far, so I think changing the documentation would be fine here.)
Created š Fix contract of IndexInterface::setDatasources() Active as a follow-up for that. Iād just fix the minimal problem with theremoveDatasource()
docs in there unless enough people comment here to support expanding those doc comments.