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 Search 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 (10-15 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 #1533384: Make search module pass Coder Review
#1310084: [meta] API documentation cleanup sprint #1355670: Clean up API docs for search module
#500866: [META] remove t() from assert message #1797508: Remove t() from assertion messages in tests for the Search module
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Mile23’s picture

Mile23’s picture

Status: Active » Needs review
FileSize
5.98 KB

Patch.

Mile23’s picture

Still applies, still shows no missing docblock @param stuff in phpcs.

Mile23’s picture

Still applies.

Mile23’s picture

Issue summary: View changes
deepakaryan1988’s picture

Assigned: Unassigned » deepakaryan1988
deepakaryan1988’s picture

Patch #2 is not working.
So I am re-rolling that patch again.

yogen.prasad’s picture

Status: Needs review » Reviewed & tested by the community

Working fine

webchick’s picture

Status: Reviewed & tested by the community » Fixed

Committed and pushed to 8.0.x. Thanks!

  • webchick committed fbd6790 on 8.0.x
    Issue #1811882 by Mile23, deepakaryan1988, Lars Toomre, yogen.prasad:...

Status: Fixed » Closed (fixed)

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