jenkins-bot has submitted this change and it was merged. ( 
https://gerrit.wikimedia.org/r/403696 )

Change subject: Improve some parameter docs
......................................................................


Improve some parameter docs

Change-Id: I1d6bece3380b6d2144feee512de736c12d62d09e
---
M .phpcs.xml
M ContributionScores_body.php
2 files changed, 7 insertions(+), 10 deletions(-)

Approvals:
  Umherirrender: Looks good to me, approved
  jenkins-bot: Verified



diff --git a/.phpcs.xml b/.phpcs.xml
index e656bbd..482be95 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -1,8 +1,6 @@
 <?xml version="1.0"?>
 <ruleset>
        <rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
-               <exclude 
name="MediaWiki.Commenting.FunctionComment.MissingParamName" />
-               <exclude 
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
                <exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
                <exclude 
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
                <exclude 
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
@@ -11,6 +9,5 @@
        </rule>
        <file>.</file>
        <arg name="extensions" value="php,php5,inc" />
-       <arg name="encoding" value="utf8" />
-       <exclude-pattern>vendor</exclude-pattern>
+       <arg name="encoding" value="UTF-8" />
 </ruleset>
diff --git a/ContributionScores_body.php b/ContributionScores_body.php
index 1fe0ae0..0b0c50f 100644
--- a/ContributionScores_body.php
+++ b/ContributionScores_body.php
@@ -21,11 +21,11 @@
        /**
         * Function generates Contribution Scores tables in HTML format (not 
wikiText)
         *
-        * @param $days int Days in the past to run report for
-        * @param $limit int Maximum number of users to return (default 50)
-        * @param $title Title (default null)
-        * @param $options array of options (default none; nosort/notools)
-        * @return Html Table representing the requested Contribution Scores.
+        * @param int $days Days in the past to run report for
+        * @param int $limit Maximum number of users to return (default 50)
+        * @param string|null $title The title of the table
+        * @param array $options array of options (default none; nosort/notools)
+        * @return string Html Table representing the requested Contribution 
Scores.
         */
        function genContributionScoreTable( $days, $limit, $title = null, 
$options = 'none' ) {
                global $wgContribScoreIgnoreBots, 
$wgContribScoreIgnoreBlockedUsers, $wgContribScoresUseRealName;
@@ -188,7 +188,7 @@
        /**
         * Called when being included on a normal wiki page.
         * Cache is disabled so it can depend on the user language.
-        * @param $par
+        * @param string|null $par A subpage give to the special page
         */
        function showInclude( $par ) {
                $days = null;

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

Gerrit-MessageType: merged
Gerrit-Change-Id: I1d6bece3380b6d2144feee512de736c12d62d09e
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/ContributionScores
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
Gerrit-Reviewer: Umherirrender <umherirrender_de...@web.de>
Gerrit-Reviewer: jenkins-bot <>

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

Reply via email to