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

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


Improve some parameter docs

Change-Id: I592a6c959257bb85a427ee2447febf4b0a6d0149
---
M ApiContributionTracking.php
M ContributionTracking.processor.php
M composer.json
M phpcs.xml
4 files changed, 9 insertions(+), 10 deletions(-)

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



diff --git a/ApiContributionTracking.php b/ApiContributionTracking.php
index d4c0446..5fc44f2 100644
--- a/ApiContributionTracking.php
+++ b/ApiContributionTracking.php
@@ -37,7 +37,7 @@
 
        /**
         * Assembles the data for the API to return.
-        * @param integer $id The Contribution Tracking ID.
+        * @param int $id The Contribution Tracking ID.
         * @param array $params Original (staged) request paramaters.
         */
        function doReturn( $id, $params ) {
@@ -147,6 +147,7 @@
        }
 
        /**
+        * @return array
         * @deprecated since MediaWiki core 1.25
         */
        public function getParamDescription() {
@@ -191,6 +192,7 @@
        }
 
        /**
+        * @return array
         * @deprecated since MediaWiki core 1.25
         */
        public function getDescription() {
@@ -203,6 +205,7 @@
        }
 
        /**
+        * @return array
         * @deprecated since MediaWiki core 1.25
         */
        public function getExamples() {
@@ -214,6 +217,7 @@
 
        /**
         * @see ApiBase::getExamplesMessages()
+        * @return array
         */
        protected function getExamplesMessages() {
                return [
diff --git a/ContributionTracking.processor.php 
b/ContributionTracking.processor.php
index 92050af..3f948fd 100644
--- a/ContributionTracking.processor.php
+++ b/ContributionTracking.processor.php
@@ -123,7 +123,7 @@
        /**
         * Effectively changes the name of a key in an array. If the key does 
not
         * exist, no change is made.
-        * @param array $array The array to rekey (by reference)
+        * @param array &$array The array to rekey
         * @param string $oldkey The key to change
         * @param string $newkey The new value for the key
         */
@@ -138,7 +138,7 @@
         * Stages a value generated by a checkbox or similar control, for use 
in our
         *  database. If the key exists and has not been set to exactly false, 
it's
         * "true".
-        * @param array $array The array containing the value to stage, by 
reference
+        * @param array &$array The array containing the value to stage
         * @param string $key The key of a checkbox-generated value
         */
        static function stage_checkbox( &$array, $key ) {
@@ -213,7 +213,7 @@
         * @param array $params Form / API data
         * @param array $defaults A set of default values for a particular
         * transaction type
-        * @param boolean $nullify If true, keys with empty string values will 
be
+        * @param bool $nullify If true, keys with empty string values will be
         * set to null in the return array.
         * @return array
         */
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 5bc70ff..33ae494 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -2,15 +2,10 @@
 <ruleset>
        <rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
                <exclude 
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
-               <exclude 
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
-               <exclude 
name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
-               <exclude 
name="MediaWiki.Commenting.FunctionComment.ParamNameNoMatch" />
                <exclude 
name="MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName" />
                <exclude 
name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment"/>
        </rule>
        <file>.</file>
        <arg name="extensions" value="php,php5,inc"/>
        <arg name="encoding" value="UTF-8"/>
-       <exclude-pattern>vendor</exclude-pattern>
-       <exclude-pattern>node_modules</exclude-pattern>
 </ruleset>

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

Gerrit-MessageType: merged
Gerrit-Change-Id: I592a6c959257bb85a427ee2447febf4b0a6d0149
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/ContributionTracking
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
Gerrit-Reviewer: Jforrester <jforres...@wikimedia.org>
Gerrit-Reviewer: Legoktm <lego...@member.fsf.org>
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