Thiemo Mättig (WMDE) has uploaded a new change for review. ( 
https://gerrit.wikimedia.org/r/370872 )

Change subject: Fix slightly broken @return documentations
......................................................................

Fix slightly broken @return documentations

* We are consistently using "@return" without "s".
* Neither "false" nor "true" are types. "bool" is the type.

Change-Id: I07b09e74555de4aaa451366240fe7e13ea80f4d7
---
M client/includes/Changes/WikiPageUpdater.php
M lib/includes/WikibaseSettings.php
M repo/includes/Search/Elastic/ElasticTermResult.php
3 files changed, 6 insertions(+), 6 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Wikibase 
refs/changes/72/370872/1

diff --git a/client/includes/Changes/WikiPageUpdater.php 
b/client/includes/Changes/WikiPageUpdater.php
index 2ab62a5..2739bc9 100644
--- a/client/includes/Changes/WikiPageUpdater.php
+++ b/client/includes/Changes/WikiPageUpdater.php
@@ -165,7 +165,7 @@
        /**
         * @param Title[] $titles
         *
-        * @returns array[] string $pageId => [ int $namespace, string $dbKey ]
+        * @return array[] string $pageId => [ int $namespace, string $dbKey ]
         */
        private function getPageParamForRefreshLinksJob( array $titles ) {
                $pages = [];
diff --git a/lib/includes/WikibaseSettings.php 
b/lib/includes/WikibaseSettings.php
index 059a562..ad5abdc 100644
--- a/lib/includes/WikibaseSettings.php
+++ b/lib/includes/WikibaseSettings.php
@@ -23,7 +23,7 @@
 class WikibaseSettings {
 
        /**
-        * @returns true if and only if the Wikibase repository component is 
enabled on this wiki.
+        * @return bool True if and only if the Wikibase repository component 
is enabled on this wiki.
         */
        public static function isRepoEnabled() {
                return defined( 'WB_VERSION' );
@@ -35,7 +35,7 @@
         *
         * @throws MWException
         *
-        * @returns SettingsArray
+        * @return SettingsArray
         */
        public static function getRepoSettings() {
                if ( !self::isRepoEnabled() ) {
@@ -48,7 +48,7 @@
        }
 
        /**
-        * @returns true if and only if the Wikibase client component is 
enabled on this wiki.
+        * @return bool True if and only if the Wikibase client component is 
enabled on this wiki.
         */
        public static function isClientEnabled() {
                return defined( 'WBC_VERSION' );
@@ -57,7 +57,7 @@
        /**
         * @throws MWException
         *
-        * @returns SettingsArray
+        * @return SettingsArray
         */
        public static function getClientSettings() {
                if ( !self::isClientEnabled() ) {
diff --git a/repo/includes/Search/Elastic/ElasticTermResult.php 
b/repo/includes/Search/Elastic/ElasticTermResult.php
index b6bc9e9..6d1b043 100644
--- a/repo/includes/Search/Elastic/ElasticTermResult.php
+++ b/repo/includes/Search/Elastic/ElasticTermResult.php
@@ -52,7 +52,7 @@
        /**
         * Get the source filtering to be used loading the result.
         *
-        * @return false|string|array corresponding to Elasticsearch source 
filtering syntax
+        * @return string[]
         */
        public function getSourceFiltering() {
                $fields = [ 'namespace', 'title' ];

-- 
To view, visit https://gerrit.wikimedia.org/r/370872
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I07b09e74555de4aaa451366240fe7e13ea80f4d7
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Wikibase
Gerrit-Branch: master
Gerrit-Owner: Thiemo Mättig (WMDE) <thiemo.maet...@wikimedia.de>

_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to