This is a part of the attempt to fix #2572645: [Meta] Fix 'Drupal.Commenting.FunctionComment' coding standard

Step 0: Reading

Read xjm's comment on the fixing type hints.

This issue is created to work on the sub-sniff

Drupal.Commenting.FunctionComment.MissingParamType

Remaining tasks

Enable the sniff and fix any remaining problems.

Completed

#3478225: Fix MissingParamType in include files
#3478172: Add MissingParamType for views
#3478175: Fix MissingParamType for Database related
#3478204: Fix MissingParamType in core/lib/Drupal/Core
#3478166: Add MissingParamType for form, form_state and form_id
#3478185: Fix MissingParamType for tests
#3478200: Fix MissingParamType in core/lib/Drupal/Component
#3478220: Fix MissingParamType in modules not views

CommentFileSizeAuthor
#49 3207949-nr-bot.txt20.61 KBneeds-review-queue-bot
#35 3207949-35.patch132.13 KBquietone
#34 3207949-32.patch23.35 KBquietone
#30 3207949-29.patch123.91 KBquietone
#24 3207949-23.patch123.87 KBquietone
#24 diff-20-23.txt37.59 KBquietone
#21 3207949-20.patch133.81 KBquietone
#21 interdiff-19-20.txt18.85 KBquietone
#19 3207949-19.patch135.96 KBquietone
#19 interdiff-17-19.txt41.99 KBquietone
#17 3207949-17.patch87.34 KBquietone
#17 interdiff-16-17.txt3.89 KBquietone
#16 3207949-16.patch83.46 KBquietone
#16 interdiff-15-16.txt8.34 KBquietone
#15 3207949-15.patch75.12 KBquietone
#15 interdiff-6-15.txt2.04 KBquietone
#13 interdiff_6_11.txt18.9 KBkapilv
#11 3207949-11.patch86.91 KBkapilv
#10 interdiff-10.txt18.87 KBkapilv
#10 3207949-10.patch86.88 KBkapilv
#9 interdiff-9.txt16.83 KBkapilv
#9 3207949-9.patch85.6 KBkapilv
#6 3207949-6.patch73.08 KBquietone
#6 interdiff-5-6.txt10.09 KBquietone
#5 3207949-5.patch60.97 KBquietone
#5 interdiff-4-5.txt30.89 KBquietone
#4 3207949-4.patch26.91 KBquietone
#4 interdiff-3-4.txt3.69 KBquietone
#3 3207949-3.patch22.63 KBquietone
#3 interdiff-2-3.txt12.25 KBquietone
#2 3207949-2.patch8.17 KBquietone

Issue fork drupal-3207949

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

quietone created an issue. See original summary.

quietone’s picture

quietone commented
Issue summary: View changes
Status: Active » Needs work
StatusFileSize
new 3207949-2.patch8.17 KB

This patch includes work from #1800330: Add missing type hinting to System module docblocks, now closed as a duplicate. Credit to add, Lars Toomre, Mile23, naveenvalecha, prashantgoel, jhodgdon. Let me know if the credit is correct.

quietone’s picture

quietone commented
StatusFileSize
new interdiff-2-3.txt12.25 KB
new 3207949-3.patch22.63 KB

This patch includes work from #2651280: Add missing type hinting to System module TEST docblocks, now closed as a duplicate. Credit to add, naveenvalecha. Let me know if the credit is correct.

quietone’s picture

quietone commented
StatusFileSize
new interdiff-3-4.txt3.69 KB
new 3207949-4.patch26.91 KB

This patch includes work from #2651280: Add missing type hinting to System module TEST docblocks, now closed as a duplicate. Credit to add, Mile23, jhodgdon, naveenvalecha. Let me know if the credit is correct.

quietone’s picture

quietone commented
StatusFileSize
new interdiff-4-5.txt30.89 KB
new 3207949-5.patch60.97 KB

This patch includes work from
#1800546: Add missing type hinting to Node module docblocks
#1801998: Add missing type hinting to Field module docblocks
#1802060: Add missing type hinting to Image module docblocks
#1807002: Add missing type hinting to Taxonomy module docblocks
#1807674: Add missing type hinting to Block module docblocks
#1811202: Add missing type hinting to Update module docblocks

all now closed as duplicates. Credit to add, Lars Toomre, Jalandhar, adci_contributor, ideb, suhel.rangnekar, seanr, Jeroen, mrjmd, willzyx , xjm, deepakaryan1988, shetpooja04. Let me know if the credit is correct.

quietone’s picture

quietone commented
StatusFileSize
new interdiff-5-6.txt10.09 KB
new 3207949-6.patch73.08 KB

Another increment, this includes changes to all migrate related files.

quietone’s picture

quietone commented
Issue tags: +Coding standards
kapilv’s picture

kapilv commented
Assigned: Unassigned » kapilv
kapilv’s picture

kapilv commented
Assigned: kapilv » Unassigned
Status: Needs work » Needs review
StatusFileSize
new 3207949-9.patch85.6 KB
new interdiff-9.txt16.83 KB

fixed Coding standards.

kapilv’s picture

kapilv commented
StatusFileSize
new 3207949-10.patch86.88 KB
new interdiff-10.txt18.87 KB
kapilv’s picture

kapilv commented
StatusFileSize
new 3207949-11.patch86.91 KB
quietone’s picture

quietone commented
Status: Needs review » Needs work

@KapilV Have a look at the instructions for running the coding standard checks locally so you can be sure the tests will run before uploading a patch. It also has the advantage of saving resources, including money, for the Drupal association. There are real costs for running the tests.

The latest patch does not have an interdiff. Can you make one against patch #6 and upload it.

kapilv’s picture

kapilv commented
StatusFileSize
new interdiff_6_11.txt18.9 KB

@quietone Thank you for the suggestion. I have uploaded interdiff.

quietone’s picture

quietone commented
Issue summary: View changes

Add reference to xjm's comment about the challenges of fixing documentation.

quietone’s picture

quietone commented
Assigned: Unassigned » quietone
Status: Needs work » Active
StatusFileSize
new interdiff-6-15.txt2.04 KB
new 3207949-15.patch75.12 KB

The patch in #11 has out of scope changes, so I have skipped it for now.

Add changes from #2610064: Wrong @param and @return doc comment in file.api.php credit given to rakesh.gectcr
Add changes from #1807678: Add missing type hinting to Book module docblocks credit to Mile23, Lars Toomre, jhodgdon

quietone’s picture

quietone commented
StatusFileSize
new interdiff-15-16.txt8.34 KB
new 3207949-16.patch83.46 KB

Add changes from #2933570: Clean up PHP doc @param and @return types for entity revision IDs credit given to plach
Add changes from #2863877: Coding standards problems in Schema.php credit given to adriancid, daffie,cilefen

quietone’s picture

quietone commented
StatusFileSize
new interdiff-16-17.txt3.89 KB
new 3207949-17.patch87.34 KB

Add changes from #2210565: Docblock and code style improvements in core/includes/bootstrap.inc credit given to donquixote, sushyl

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone’s picture

quietone commented
StatusFileSize
new interdiff-17-19.txt41.99 KB
new 3207949-19.patch135.96 KB

quietone credited rakesh.gectcr.

quietone’s picture

quietone commented
StatusFileSize
new interdiff-19-20.txt18.85 KB
new 3207949-20.patch133.81 KB

Update patch and merge changes from #2607110: Comment doc missing @return type in Class ThemeRegistry and token.api.php, adding credit.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone credited Mile23.

quietone’s picture

quietone commented
StatusFileSize
new diff-20-23.txt37.59 KB
new 3207949-23.patch123.87 KB

Add changes from #2533234: Marginally improve docs for database system and adding credit to Mile23.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone credited ricardoamaro.

quietone credited shashikant_chauhan.

quietone’s picture

quietone commented

Closing #2795793: missing params and return docs for acceptExposedInput() and adding credit for that work to this issue,

quietone credited ro-no-lo.

quietone’s picture

quietone commented
StatusFileSize
new 3207949-29.patch123.91 KB

Closed #1965626: theme.inc - PHP cleanup and Documentation updates. as a duplicate an adding credit.

I also updated the patch. This is not ready for testing.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone credited immaculatexavier.

quietone credited Pancho.

quietone’s picture

quietone commented
Issue summary: View changes
StatusFileSize
new 3207949-32.patch23.35 KB

Updated the patch to 10.1.x.

Added changes from #3034944: Fix docblocks in Views filter plugins and adding credit,

quietone’s picture

quietone commented
StatusFileSize
new 3207949-35.patch132.13 KB

Wrong patch.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone’s picture

quietone commented
Issue summary: View changes
quietone’s picture

quietone commented
Issue summary: View changes
quietone’s picture

quietone commented
Issue summary: View changes
quietone’s picture

quietone commented
Assigned: quietone » Unassigned
Anonymous’s picture

Anonymous (not verified) commented
Assigned: Unassigned »
Anonymous’s picture

Anonymous (not verified) commented
Assigned: » Unassigned
quietone’s picture

quietone commented
Issue summary: View changes
quietone’s picture

quietone commented
Issue summary: View changes

longwave made their first commit to this issue’s fork.

longwave opened merge request !10790

longwave’s picture

longwave
he/him
Primary language English
Location UK
commented
Issue summary: View changes
Status: Active » Needs review

Not much left to do here to enable the sniff globally.

Inspector needed some code changes, I think these are OK to do here though as I can't see anyone overriding or extending this class.

smustgrave’s picture

smustgrave commented
Status: Needs review » Reviewed & tested by the community

Woo! Excellent work

Remaining changes seem fine to me.

needs-review-queue-bot’s picture

needs-review-queue-bot commented
Status: Reviewed & tested by the community » Needs work
StatusFileSize
new 3207949-nr-bot.txt20.61 KB

The Needs Review Queue Bot tested this issue. It fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

quietone’s picture

quietone commented
Status: Needs work » Needs review

Update for recent commits

smustgrave’s picture

smustgrave commented
Status: Needs review » Reviewed & tested by the community

Rebase seems good.

nod_ made their first commit to this issue’s fork.

  • nod_ committed d1a4f6e0 on 11.x 
    Issue #3207949 by quietone, kapilv, longwave, rakesh.gectcr, mile23, ro-...

nod_ closed merge request !10790

nod_’s picture

nod_
Primary language French
Location Lille
commented
Status: Reviewed & tested by the community » Fixed

Committed d1a4f6e and pushed to 11.x. Thanks!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

xjm’s picture

xjm
she/her
Primary language English
commented

Fixing attribution.