Umherirrender has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/382963 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: I071a0aa3b14c41e229d031ace4e46c1908e87e95
---
M includes/WikidataPageBanner.functions.php
M phpcs.xml
M tests/phpunit/BannerTest.php
3 files changed, 9 insertions(+), 11 deletions(-)
git pull
ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/WikidataPageBanner
refs/changes/63/382963/1
diff --git a/includes/WikidataPageBanner.functions.php
b/includes/WikidataPageBanner.functions.php
index ac6547d..c06cb70 100644
--- a/includes/WikidataPageBanner.functions.php
+++ b/includes/WikidataPageBanner.functions.php
@@ -18,7 +18,7 @@
/**
* Set bannertoc variable on parser output object
*
- * @param array $paramsForBannerTemplate banner parameters array
+ * @param array &$paramsForBannerTemplate banner parameters array
* @param array $options options from parser function
*/
public static function addToc( &$paramsForBannerTemplate, $options ) {
@@ -30,7 +30,7 @@
/**
* Render icons using OOJS-UI for icons which are set in arguments
*
- * @param array $paramsForBannerTemplate Parameters defined for banner
template
+ * @param array &$paramsForBannerTemplate Parameters defined for banner
template
* @param array $argumentsFromParserFunction Arguments passed to
{{PAGEBANNER}} function
*/
public static function addIcons( &$paramsForBannerTemplate,
$argumentsFromParserFunction ) {
@@ -73,7 +73,7 @@
/**
* Sets focus parameter on banner templates to shift focus on banner
when cropped
*
- * @param array $paramsForBannerTemplate Parameters defined for banner
template
+ * @param array &$paramsForBannerTemplate Parameters defined for banner
template
* @param array $argumentsFromParserFunction Arguments passed to
{{PAGEBANNER}} function
*/
public static function addFocus( &$paramsForBannerTemplate,
$argumentsFromParserFunction ) {
@@ -377,7 +377,7 @@
/**
* Adds banner custom CSS classes according to extraClass parameter
*
- * @param array $paramsForBannerTemplate Parameters defined for banner
template
+ * @param array &$paramsForBannerTemplate Parameters defined for banner
template
* @param array $argumentsFromParserFunction Arguments passed to
{{PAGEBANNER}} function
*/
public static function addCssClasses( &$paramsForBannerTemplate,
diff --git a/phpcs.xml b/phpcs.xml
index d66f3df..bd56c1c 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -2,12 +2,10 @@
<ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.ParamNameNoMatch" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude name="MediaWiki.Files.OneClassPerFile.MultipleFound" />
</rule>
<file>.</file>
<arg name="extensions" value="php" />
- <exclude-pattern>vendor</exclude-pattern>
+ <arg name="encoding" value="UTF-8" />
</ruleset>
diff --git a/tests/phpunit/BannerTest.php b/tests/phpunit/BannerTest.php
index 35e12f1..91fbdb8 100644
--- a/tests/phpunit/BannerTest.php
+++ b/tests/phpunit/BannerTest.php
@@ -86,10 +86,10 @@
/**
* @dataProvider provideTestDefaultBanner
* @covers addDefaultBanner(...)
- * @param {String} $title of page banner being generated on
- * @param {Number} $ns namespace of title
- * @param {String} $customBanner parameter given to PAGEBANNER magic
word
- * @param {String} $expected the name of the banner we output.
+ * @param string $title of page banner being generated on
+ * @param number $ns namespace of title
+ * @param string $customBanner parameter given to PAGEBANNER magic word
+ * @param string $expected the name of the banner we output.
*/
public function testDefaultBanner( $title, $ns, $customBanner,
$expected ) {
$out = $this->createPage( $title, $ns, $customBanner );
--
To view, visit https://gerrit.wikimedia.org/r/382963
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I071a0aa3b14c41e229d031ace4e46c1908e87e95
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/WikidataPageBanner
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
