diff options
| author | apaskulin <apaskulin@wikimedia.org> | 2020-05-29 11:10:32 -0700 |
|---|---|---|
| committer | apaskulin <apaskulin@wikimedia.org> | 2020-05-29 11:10:32 -0700 |
| commit | 590d8a9b062bbbcaa68b94c3141421de4517f040 (patch) | |
| tree | 4e50be22be24aaa60fbcdf06e0f58351da4f72a6 /includes/Rest/Hook | |
| parent | 73f41c6f2b1d04426a59283bb7a646ef08cf1f64 (diff) | |
| download | mediawikicore-590d8a9b062bbbcaa68b94c3141421de4517f040.tar.gz mediawikicore-590d8a9b062bbbcaa68b94c3141421de4517f040.zip | |
docs: Fix typo in doc comment
Fixes a typo in the doc comment for two hook interfaces.
Change-Id: I8b2075ea0029620baef4514439c22b727a1f9c42
Diffstat (limited to 'includes/Rest/Hook')
| -rw-r--r-- | includes/Rest/Hook/SearchResultProvideDescriptionHook.php | 8 | ||||
| -rw-r--r-- | includes/Rest/Hook/SearchResultProvideThumbnailHook.php | 8 |
2 files changed, 8 insertions, 8 deletions
diff --git a/includes/Rest/Hook/SearchResultProvideDescriptionHook.php b/includes/Rest/Hook/SearchResultProvideDescriptionHook.php index fe32c9390815..6645c1dbcb49 100644 --- a/includes/Rest/Hook/SearchResultProvideDescriptionHook.php +++ b/includes/Rest/Hook/SearchResultProvideDescriptionHook.php @@ -4,8 +4,8 @@ namespace MediaWiki\Rest\Hook; /** * Called by REST SearchHandler in order to allow extensions to fill the 'description' - * field in search results. Warning: this hook as well as SearchResultPageIdentity interface - * is being under development and still unstable. + * field in search results. Warning: this hook, as well as SearchResultPageIdentity interface, + * is under development and still unstable. * * @unstable * @ingroup Hooks @@ -17,8 +17,8 @@ interface SearchResultProvideDescriptionHook { * * @since 1.35 * - * @param array $pageIdentities an array (string=>SearchResultPageIdentity) where key is pageId. - * @param array &$descriptions an output array (string=>string|null) where key + * @param array $pageIdentities Array (string=>SearchResultPageIdentity) where key is pageId + * @param array &$descriptions Output array (string=>string|null) where key * is pageId and value is either a description for given page or null */ public function onSearchResultProvideDescription( array $pageIdentities, &$descriptions ); diff --git a/includes/Rest/Hook/SearchResultProvideThumbnailHook.php b/includes/Rest/Hook/SearchResultProvideThumbnailHook.php index ffa2f182e9a9..40b1beed946a 100644 --- a/includes/Rest/Hook/SearchResultProvideThumbnailHook.php +++ b/includes/Rest/Hook/SearchResultProvideThumbnailHook.php @@ -4,8 +4,8 @@ namespace MediaWiki\Rest\Hook; /** * Called by REST SearchHandler in order to allow extensions to fill the 'thumbnail' - * field in rest search results. Warning: this hook as well as SearchResultPageIdentity - * interface is being under development and still unstable. + * field in rest search results. Warning: this hook, as well as SearchResultPageIdentity + * interface, is under development and still unstable. * * @unstable * @ingroup Hooks @@ -17,8 +17,8 @@ interface SearchResultProvideThumbnailHook { * * @since 1.35 * - * @param array $pageIdentities an array (string=>SearchResultPageIdentity) where key is pageId. - * @param array &$thumbnails an output array (string=>SearchResultThumbnail|null) where key + * @param array $pageIdentities Array (string=>SearchResultPageIdentity) where key is pageId + * @param array &$thumbnails Output array (string=>SearchResultThumbnail|null) where key * is pageId and value is either a valid SearchResultThumbnail for given page or null */ public function onSearchResultProvideThumbnail( array $pageIdentities, &$thumbnails ); |