Page MenuHomePhabricator
Create Task
Maniphest T243932

Fix phpcs exclusions (8 microtasks)
Closed, ResolvedPublic
Actions

Description

There are a few coding style exclusions that should be fixed in ProofreadPage:

  • MediaWiki.Commenting.FunctionComment.MissingDocumentationPrivate
  • MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected
  • MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic
  • MediaWiki.Commenting.FunctionComment.MissingParamTag
  • MediaWiki.Commenting.FunctionComment.MissingReturn
  • MediaWiki.Files.ClassMatchesFilename.NotMatch
  • MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment
  • PSR12.Properties.ConstantVisibility.NotFound

For each exclusion, remove it from .phpcs.xml and fix the code accordingly so that ./vendor/bin/phpcs runs without error. Each should be submitted as a separate patch to make it easier to review.

Getting Started Resources

Details

SubjectRepoBranchLines +/-
Fixed missing public function documentation errormediawiki/extensions/ProofreadPagemaster+107 -3
Rename ProofreadPage.body.php to ProofreadPage.phpmediawiki/extensions/ProofreadPagemaster+49 -32
PHPcs: Fix Space before single line comment errormediawiki/extensions/ProofreadPagemaster+36 -19
Phpcs : fix Private function documention errormediawiki/extensions/ProofreadPagemaster+87 -4
Phpcs: fix excluded protected documentation errormediawiki/extensions/ProofreadPagemaster+16 -1
Customize query in gerrit

Related Objects

Event Timeline

Samwilson created this task.Jan 30 2020, 12:39 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJan 30 2020, 12:39 AM
srishakatux updated the task description. (Show Details)Feb 5 2020, 1:26 AM
gerritbot added a comment.Feb 11 2020, 6:22 PM

Change 571549 had a related patch set uploaded (by Prondubuisi; owner: Prondubuisi):
[mediawiki/extensions/ProofreadPage@master] Phpcs: fix excluded protected documentation error

https://gerrit.wikimedia.org/r/571549

gerritbot added a project: Patch-For-Review.Feb 11 2020, 6:22 PM
Prondubuisi subscribed.EditedFeb 11 2020, 6:26 PM

Hello @Samwilson I am A student interested in GSoC, and I have proposed a fix for one of the PHPcs issues, thanks.

gerritbot added a comment.Feb 12 2020, 4:05 AM

Change 571549 merged by jenkins-bot:
[mediawiki/extensions/ProofreadPage@master] Phpcs: fix excluded protected documentation error

https://gerrit.wikimedia.org/r/571549

Maintenance_bot removed a project: Patch-For-Review.Feb 12 2020, 4:10 AM
DannyS712 updated the task description. (Show Details)Feb 12 2020, 4:23 AM
DannyS712 subscribed.
ReleaseTaggerBot added a project: MW-1.35-notes (1.35.0-wmf.20; 2020-02-18).Feb 12 2020, 5:00 AM
gerritbot added a comment.Feb 14 2020, 3:16 AM

Change 572136 had a related patch set uploaded (by Prondubuisi; owner: Prondubuisi):
[mediawiki/extensions/ProofreadPage@master] Phpcs : fix Private function documention error

https://gerrit.wikimedia.org/r/572136

gerritbot added a project: Patch-For-Review.Feb 14 2020, 3:16 AM
Sahajsk subscribed.Feb 18 2020, 10:11 AM
gerritbot added a comment.Feb 23 2020, 5:29 AM

Change 574224 had a related patch set uploaded (by Sohom Datta; owner: Sohom Datta):
[mediawiki/extensions/ProofreadPage@master] Fixed missing public function documentation error

https://gerrit.wikimedia.org/r/574224

Soda subscribed.Feb 23 2020, 3:37 PM
Soda added a subscriber: Jayprakash12345.Feb 28 2020, 7:45 PM

@Jayprakash12345 Could you guide me on how to fix the errors that came up in the checking build.... I am unable to reproduce them locally using docker-dev, there are no errors given by composer or npm and I can't figure out what phan does or how to install it..

Prondubuisi added a comment.EditedFeb 29 2020, 1:00 PM
In T243932#5927763, @Soda wrote:

@Soda Could you guide me on how to fix the errors that came up in the checking build.... I am unable to reproduce them locally using docker-dev, there are no errors given by composer or npm and I can't figure out what phan does or how to install it..

Hello @Jayprakash12345 this is a guide on setting on Phan locally https://www.mediawiki.org/wiki/Continuous_integration/Phan#Running_Phan

Soda added a comment.Feb 29 2020, 1:58 PM

@Prondubuisi Thanks for the help. I realised where I messed up. Commit updated. BTW, I was asking for advice, Jayprakash was rechecking my patch via Jenkin's Bot... 😄

Prondubuisi added a comment.Feb 29 2020, 5:31 PM
In T243932#5929055, @Soda wrote:

@Prondubuisi Thanks for the help. I realised where I messed up. Commit updated. BTW, I was asking for advice, Jayprakash was rechecking my patch via Jenkin's Bot... 😄

Lol. Senior Developer problems!

Kizule subscribed.Feb 29 2020, 7:54 PM

I don't see so much exclusions from description, in .phpcs.xml. https://gerrit.wikimedia.org/r/#/c/mediawiki/extensions/ProofreadPage/+/574224/2/.phpcs.xml

Samwilson updated the task description. (Show Details)Mar 3 2020, 8:42 AM

I don't see so much exclusions from description, in .phpcs.xml. https://gerrit.wikimedia.org/r/#/c/mediawiki/extensions/ProofreadPage/+/574224/2/.phpcs.xml

I've updated the list in the task description (a few have been done already).

gerritbot added a comment.Mar 4 2020, 1:16 AM

Change 572136 merged by jenkins-bot:
[mediawiki/extensions/ProofreadPage@master] Phpcs : fix Private function documention error

https://gerrit.wikimedia.org/r/572136

ReleaseTaggerBot edited projects, added MW-1.35-notes (1.35.0-wmf.24; 2020-03-17); removed MW-1.35-notes (1.35.0-wmf.20; 2020-02-18).Mar 4 2020, 2:00 AM
Jdforrester-WMF edited projects, added MW-1.35-notes (1.35.0-wmf.23; 2020-03-10); removed MW-1.35-notes (1.35.0-wmf.24; 2020-03-17).Mar 5 2020, 3:00 PM
gerritbot added a comment.Mar 5 2020, 9:13 PM

Change 577342 had a related patch set uploaded (by Prondubuisi; owner: Prondubuisi):
[mediawiki/extensions/ProofreadPage@master] PHPcs: T243932 fix phpcs space before single line comment error in different php files where the error occurs

https://gerrit.wikimedia.org/r/577342

Prondubuisi added a comment.Mar 5 2020, 9:15 PM

Hello @Samwilson can I edit the task description to tick the tasks that have been merged?

Samwilson added a comment.Mar 6 2020, 1:29 AM

Hello @Samwilson can I edit the task description to tick the tasks that have been merged?

Yes, definitely; thanks!

Prondubuisi updated the task description. (Show Details)Mar 6 2020, 2:02 AM
Soda added a comment.Mar 6 2020, 5:31 AM

I've rebased my patch on the latest version ( it was merge-conflicting ) @Samwilson could you take a look at it....

Soda mentioned this in T172953: Create OOUI widget for Index page pagelists.Mar 6 2020, 5:33 AM
gerritbot added a comment.Mar 6 2020, 5:35 AM

Change 577413 had a related patch set uploaded (by Prondubuisi; owner: Prondubuisi):
[mediawiki/extensions/ProofreadPage@master] PHPcs: T243932 fix PHPcs filename and classname mismatch error update relevent bootstrap files to reflect the change

https://gerrit.wikimedia.org/r/577413

gerritbot added a comment.Mar 6 2020, 12:53 PM

Change 577413 had a related patch set uploaded (by Thiemo Kreuz (WMDE); owner: Prondubuisi):
[mediawiki/extensions/ProofreadPage@master] Rename ProofreadPage.body.php to ProofreadPage.php

https://gerrit.wikimedia.org/r/577413

gerritbot added a comment.Mar 7 2020, 9:28 AM

Change 577342 had a related patch set uploaded (by Prondubuisi; owner: Prondubuisi):
[mediawiki/extensions/ProofreadPage@master] PHPcs: Fix Space before single line error

https://gerrit.wikimedia.org/r/577342

gerritbot added a comment.Mar 9 2020, 11:56 PM

Change 577342 merged by jenkins-bot:
[mediawiki/extensions/ProofreadPage@master] PHPcs: Fix Space before single line comment error

https://gerrit.wikimedia.org/r/577342

Samwilson updated the task description. (Show Details)Mar 10 2020, 12:24 AM
Soda mentioned this in T247157: [Proposal] Create OOUI widget for Index page pagelists {Google Summer of Code 2020}.Mar 14 2020, 2:14 PM
gerritbot added a comment.Mar 25 2020, 2:16 AM

Change 577413 merged by jenkins-bot:
[mediawiki/extensions/ProofreadPage@master] Rename ProofreadPage.body.php to ProofreadPage.php

https://gerrit.wikimedia.org/r/577413

Samwilson updated the task description. (Show Details)Mar 25 2020, 2:29 AM
ReleaseTaggerBot edited projects, added MW-1.35-notes (1.35.0-wmf.26; 2020-03-31); removed MW-1.35-notes (1.35.0-wmf.23; 2020-03-10).Mar 25 2020, 3:00 AM
gerritbot added a comment.May 11 2020, 4:55 AM

Change 574224 merged by jenkins-bot:
[mediawiki/extensions/ProofreadPage@master] Fixed missing public function documentation error

https://gerrit.wikimedia.org/r/574224

ReleaseTaggerBot edited projects, added MW-1.35-notes (1.35.0-wmf.32; 2020-05-12); removed MW-1.35-notes (1.35.0-wmf.26; 2020-03-31).May 11 2020, 5:00 AM
Samwilson closed this task as Resolved.May 11 2020, 7:10 AM
Samwilson claimed this task.
Samwilson updated the task description. (Show Details)

All done! Thanks everyone.

Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL