Page MenuHomePhabricator
Create Task
Maniphest T324266

Add doc blocks to public and protected PHP methods and remove those phpcs exceptions
Closed, ResolvedPublic
Actions

Description

MissingDocumentationPublic and MissingDocumentationProtected are our last two exceptions in the PHP CodeSniffer rules file (.phpcs.xml). Can turn the exceptions off once the documentation is added.

image.png (351×1 px, 43 KB)

  • Remove MissingDocumentationPublic exclusion (patch)
  • Remove MissingDocumentationProtected exclusion (patch)

Details

SubjectRepoBranchLines +/-
build: Remove phpcs MissingDocumentationPublic exclusionmediawiki/extensions/PageTriagemaster+45 -3
Removing a phpcs rule exclusionmediawiki/extensions/PageTriagemaster+1 -1
Customize query in gerrit

Event Timeline

Novem_Linguae created this task.Dec 1 2022, 10:19 PM
Restricted Application added a project: Growth-Team. · View Herald TranscriptDec 1 2022, 10:19 PM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
Novem_Linguae renamed this task from Add documentation to public and protected PHP methods to Add doc blocks to public and protected PHP methods.Dec 1 2022, 10:20 PM
Novem_Linguae moved this task from Backlog to Priority technical debt on the PageTriage board.Dec 6 2022, 11:21 PM
gerritbot added a comment.Dec 7 2022, 5:48 AM

Change 865239 had a related patch set uploaded (by MPGuy2824; author: MPGuy2824):

[mediawiki/extensions/PageTriage@master] Removing a phpcs rule exclusion

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

gerritbot added a project: Patch-For-Review.Dec 7 2022, 5:48 AM
MPGuy2824 subscribed.Dec 7 2022, 5:52 AM

Removing the MissingDocumentationPublic exclusion led to 12 issues.

FILE: ...ageTriage/includes/Notifications/PageTriagePresentationModel.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 53 | ERROR | Missing function doc comment
    |       | (MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic)
----------------------------------------------------------------------


FILE: .../src/extensions/PageTriage/includes/Api/ApiPageTriageTagging.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 157 | ERROR | Missing function doc comment
     |       | (MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic)
----------------------------------------------------------------------


FILE: ...c/extensions/PageTriage/includes/Api/ApiPageTriageTagCopyvio.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 82 | ERROR | Missing function doc comment
    |       | (MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic)
----------------------------------------------------------------------


FILE: ...e/src/extensions/PageTriage/includes/Api/ApiPageTriageAction.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 194 | ERROR | Missing function doc comment
     |       | (MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic)
----------------------------------------------------------------------


FILE: ...ace/src/extensions/PageTriage/includes/Api/ApiPageTriageList.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 524 | ERROR | Missing function doc comment
     |       | (MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic)
----------------------------------------------------------------------


FILE: ...PageTriage/includes/ArticleCompile/ArticleCompileDeletionTag.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 10 | ERROR | Missing function doc comment
    |       | (MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic)
----------------------------------------------------------------------


FILE: ...s/PageTriage/includes/ArticleCompile/ArticleCompileInterface.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 56 | ERROR | Missing function doc comment
    |       | (MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic)
----------------------------------------------------------------------


FILE: ...s/PageTriage/includes/ArticleCompile/ArticleCompileProcessor.php
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 122 | ERROR | Missing function doc comment
     |       | (MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic)
----------------------------------------------------------------------


FILE: ...src/extensions/PageTriage/includes/CompileArticleMetadataJob.php
----------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
----------------------------------------------------------------------
 10 | ERROR | Missing function doc comment
    |       | (MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic)
 14 | ERROR | Missing function doc comment
    |       | (MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic)
----------------------------------------------------------------------


FILE: /workspace/src/extensions/PageTriage/includes/Hooks.php
----------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
----------------------------------------------------------------------
 907 | ERROR | Missing function doc comment
     |       | (MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic)
 946 | ERROR | Missing function doc comment
     |       | (MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic)
----------------------------------------------------------------------
MPGuy2824 updated the task description. (Show Details)Dec 7 2022, 5:53 AM
gerritbot added a comment.Dec 7 2022, 10:12 AM

Change 865239 merged by jenkins-bot:

[mediawiki/extensions/PageTriage@master] Removing a phpcs rule exclusion

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

Maintenance_bot removed a project: Patch-For-Review.Dec 7 2022, 10:30 AM
ReleaseTaggerBot added a project: MW-1.40-notes (1.40.0-wmf.14; 2022-12-12).Dec 7 2022, 11:01 AM
kostajh moved this task from Inbox to Triaged on the Growth-Team board.Dec 7 2022, 12:26 PM
gerritbot added a comment.Feb 26 2023, 9:05 AM

Change 892034 had a related patch set uploaded (by MPGuy2824; author: MPGuy2824):

[mediawiki/extensions/PageTriage@master] Removing a phpcs rule exclusion (FunctionComment.MissingDocumentationPublic)

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

gerritbot added a project: Patch-For-Review.Feb 26 2023, 9:05 AM
MPGuy2824 claimed this task.Feb 26 2023, 9:22 AM
MPGuy2824 updated the task description. (Show Details)
MPGuy2824 moved this task from Priority technical debt to Code Review on the PageTriage board.
gerritbot added a comment.Feb 27 2023, 8:22 AM

Change 892034 merged by jenkins-bot:

[mediawiki/extensions/PageTriage@master] build: Remove phpcs MissingDocumentationPublic exclusion

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

Maintenance_bot removed a project: Patch-For-Review.Feb 27 2023, 8:30 AM
ReleaseTaggerBot edited projects, added MW-1.40-notes (1.40.0-wmf.25; 2023-02-27); removed MW-1.40-notes (1.40.0-wmf.14; 2022-12-12).Feb 27 2023, 9:00 AM
MPGuy2824 renamed this task from Add doc blocks to public and protected PHP methods to Add doc blocks to public and protected PHP methods and remove those phpcs exceptions.Feb 27 2023, 11:08 AM
MPGuy2824 closed this task as Resolved.
MPGuy2824 updated the task description. (Show Details)
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