[MediaWiki-commits] [Gerrit] mediawiki...GlobalUserPage[master]: Improve some parameter docs
jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/370829 )
Change subject: Improve some parameter docs
..
Improve some parameter docs
Change-Id: Ia3d5933b431cce2f3756fe80601ee1545e16981d
---
M GlobalUserPage.hooks.php
M GlobalUserPagePage.php
M composer.json
M phpcs.xml
4 files changed, 10 insertions(+), 15 deletions(-)
Approvals:
jenkins-bot: Verified
Jforrester: Looks good to me, approved
diff --git a/GlobalUserPage.hooks.php b/GlobalUserPage.hooks.php
index 5d8fb71..04e2723 100644
--- a/GlobalUserPage.hooks.php
+++ b/GlobalUserPage.hooks.php
@@ -5,7 +5,7 @@
* Adds the user option for using GlobalUserpage to
Special:GlobalPreferences.
*
* @param User $user
-* @param array $preferences Preference descriptions
+* @param array &$preferences Preference descriptions
* @return bool
*/
public static function onGetPreferences( User $user, &$preferences ) {
@@ -21,8 +21,8 @@
}
/**
-* @param Title $title
-* @param Article|null $page
+* @param Title &$title
+* @param Article|null &$page
* @param IContextSource $context
* @return bool
*/
@@ -72,7 +72,7 @@
/**
* After a LinksUpdate runs for a user page, queue remote squid purges
*
-* @param LinksUpdate $lu
+* @param LinksUpdate &$lu
* @return bool
*/
public static function onLinksUpdateComplete( LinksUpdate &$lu ) {
@@ -117,8 +117,9 @@
* or on the central global user page.
*
* @param Title $title
-* @param integer $oldid
+* @param int $oldid
* @param array &$notices
+* @return true
*/
public static function onTitleGetEditNotices( Title $title, $oldid,
array &$notices ) {
if ( !$title->exists() &&
GlobalUserPage::shouldDisplayGlobalPage( $title ) ) {
@@ -133,7 +134,7 @@
}
/**
-* @param array $ids
+* @param array &$ids
*/
public static function onGetDoubleUnderscoreIDs( array &$ids ) {
$ids[] = 'noglobal';
@@ -141,7 +142,7 @@
/**
* @param Title $title
-* @param $page
+* @param WikiPage &$page
* @return bool
*/
public static function onWikiPageFactory( Title $title, &$page ) {
diff --git a/GlobalUserPagePage.php b/GlobalUserPagePage.php
index 2766639..897ebee 100644
--- a/GlobalUserPagePage.php
+++ b/GlobalUserPagePage.php
@@ -95,7 +95,7 @@
/**
* Makes an API request to the central wiki
*
-* @param $params array
+* @param array $params
* @return array|bool false if the request failed
*/
public function makeAPIRequest( $params ) {
diff --git a/composer.json b/composer.json
index bf202bf..fd295f4 100644
--- a/composer.json
+++ b/composer.json
@@ -7,7 +7,7 @@
"scripts": {
"fix": "phpcbf",
"test": [
- "parallel-lint . --exclude vendor",
+ "parallel-lint . --exclude vendor --exclude
node_modules",
"phpcs -p -s"
]
}
diff --git a/phpcs.xml b/phpcs.xml
index 5a45644..b15894e 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -2,16 +2,10 @@
-
-
-
-
.
- vendor
- node_modules
--
To view, visit https://gerrit.wikimedia.org/r/370829
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ia3d5933b431cce2f3756fe80601ee1545e16981d
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/GlobalUserPage
Gerrit-Branch: master
Gerrit-Owner: Umherirrender
Gerrit-Reviewer: Jforrester
Gerrit-Reviewer: Legoktm
Gerrit-Reviewer: jenkins-bot <>
___
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
[MediaWiki-commits] [Gerrit] mediawiki...GlobalUserPage[master]: Improve some parameter docs
Umherirrender has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/370829 )
Change subject: Improve some parameter docs
..
Improve some parameter docs
Change-Id: Ia3d5933b431cce2f3756fe80601ee1545e16981d
---
M GlobalUserPage.hooks.php
M GlobalUserPagePage.php
M composer.json
M phpcs.xml
4 files changed, 10 insertions(+), 15 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/GlobalUserPage
refs/changes/29/370829/1
diff --git a/GlobalUserPage.hooks.php b/GlobalUserPage.hooks.php
index 5d8fb71..04e2723 100644
--- a/GlobalUserPage.hooks.php
+++ b/GlobalUserPage.hooks.php
@@ -5,7 +5,7 @@
* Adds the user option for using GlobalUserpage to
Special:GlobalPreferences.
*
* @param User $user
-* @param array $preferences Preference descriptions
+* @param array &$preferences Preference descriptions
* @return bool
*/
public static function onGetPreferences( User $user, &$preferences ) {
@@ -21,8 +21,8 @@
}
/**
-* @param Title $title
-* @param Article|null $page
+* @param Title &$title
+* @param Article|null &$page
* @param IContextSource $context
* @return bool
*/
@@ -72,7 +72,7 @@
/**
* After a LinksUpdate runs for a user page, queue remote squid purges
*
-* @param LinksUpdate $lu
+* @param LinksUpdate &$lu
* @return bool
*/
public static function onLinksUpdateComplete( LinksUpdate &$lu ) {
@@ -117,8 +117,9 @@
* or on the central global user page.
*
* @param Title $title
-* @param integer $oldid
+* @param int $oldid
* @param array &$notices
+* @return true
*/
public static function onTitleGetEditNotices( Title $title, $oldid,
array &$notices ) {
if ( !$title->exists() &&
GlobalUserPage::shouldDisplayGlobalPage( $title ) ) {
@@ -133,7 +134,7 @@
}
/**
-* @param array $ids
+* @param array &$ids
*/
public static function onGetDoubleUnderscoreIDs( array &$ids ) {
$ids[] = 'noglobal';
@@ -141,7 +142,7 @@
/**
* @param Title $title
-* @param $page
+* @param WikiPage &$page
* @return bool
*/
public static function onWikiPageFactory( Title $title, &$page ) {
diff --git a/GlobalUserPagePage.php b/GlobalUserPagePage.php
index 2766639..897ebee 100644
--- a/GlobalUserPagePage.php
+++ b/GlobalUserPagePage.php
@@ -95,7 +95,7 @@
/**
* Makes an API request to the central wiki
*
-* @param $params array
+* @param array $params
* @return array|bool false if the request failed
*/
public function makeAPIRequest( $params ) {
diff --git a/composer.json b/composer.json
index bf202bf..fd295f4 100644
--- a/composer.json
+++ b/composer.json
@@ -7,7 +7,7 @@
"scripts": {
"fix": "phpcbf",
"test": [
- "parallel-lint . --exclude vendor",
+ "parallel-lint . --exclude vendor --exclude
node_modules",
"phpcs -p -s"
]
}
diff --git a/phpcs.xml b/phpcs.xml
index 5a45644..b15894e 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -2,16 +2,10 @@
-
-
-
-
.
- vendor
- node_modules
--
To view, visit https://gerrit.wikimedia.org/r/370829
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ia3d5933b431cce2f3756fe80601ee1545e16981d
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/GlobalUserPage
Gerrit-Branch: master
Gerrit-Owner: Umherirrender
___
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
