This is a sub-issue of #1800046: [META] Add missing type hinting to core docblocks, fix Drupal.Commenting.FunctionComment.Missing* focused on correctly adding @param and @return type hinting to the Forum module.

Documentation patches that include type hinting are time consuming to both review and commit because one must dig into the actual code to confirm that the type hints are both correct and complete. Hence, please be patient and try to limit type hint patches to covering only a limited number of docblocks (20-25 as a guess).

How To Review This Issue

  1. Attempt to apply the patch to see if it needs a reroll.
  2. Use the phpcs one-liner to evaluate whether all the relevant standards errors have been resolved: https://gist.github.com/paul-m/227822ac7723b0e90647
  3. Look at each change and determine whether the type hint is correct.

Related sprint issues:

Sprint Topic Sub Issue
#1518116: [meta] Make Core pass Coder Review #1533240: Make forum module pass Coder Review
#1310084: [meta] API documentation cleanup sprint #1357138: Clean up API docs for forum module
#500866: [META] remove t() from assert message #1797286: Remove t() from assertion messages in tests for the forum module
CommentFileSizeAuthor
#6 add-missing-type-hinting-to-forum-module-docblocks-1811334-6.patch2.16 KBdeepakaryan1988
#2 1811334_2.patch2.92 KBMile23
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Mile23’s picture

Mile23
Primary language English
Location Seattle, WA
CreditAttribution: Mile23 commented
Issue summary: View changes
Parent issue: » #1800046: [META] Add missing type hinting to core docblocks, fix Drupal.Commenting.FunctionComment.Missing*
Mile23’s picture

Mile23
Primary language English
Location Seattle, WA
CreditAttribution: Mile23 commented
Status: Active » Needs review
FileSize
1811334_2.patch2.92 KB

Le Patch.

Mile23’s picture

Mile23
Primary language English
Location Seattle, WA
CreditAttribution: Mile23 commented

Patch still applies, phpcs tells me no missing type hinting.

Mile23’s picture

Mile23
Primary language English
Location Seattle, WA
CreditAttribution: Mile23 commented

Still applies.

Mile23’s picture

Mile23
Primary language English
Location Seattle, WA
CreditAttribution: Mile23 commented
Issue summary: View changes
deepakaryan1988’s picture

deepakaryan1988
Primary language Hindi
CreditAttribution: deepakaryan1988 at Srijan | A Material+ Company commented
Issue tags: +india
FileSize
add-missing-type-hinting-to-forum-module-docblocks-1811334-6.patch2.16 KB

Patch#2 is not applying so I am re-rolling that patch.

yogen.prasad’s picture

yogen.prasad CreditAttribution: yogen.prasad commented
Status: Needs review » Reviewed & tested by the community

Working fine.

  • webchick committed 6889e50 on 8.0.x 
    Issue #1811334 by Mile23, deepakaryan1988, Lars Toomre, yogen.prasad:...
webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
CreditAttribution: webchick at Acquia commented
Status: Reviewed & tested by the community » Fixed

Committed and pushed to 8.0.x. Thanks!

Status: Fixed » Closed (fixed)

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