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 Path 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 #1533266: Make path module pass Coder Review
#1310084: [meta] API documentation cleanup sprint #1811948: Further clean up of API docs for Path module
#500866: [META] remove t() from assert message #1797372: Remove t() from assertion messages in tests for the path module
CommentFileSizeAuthor
#2 1811874_2.patch446 bytesmile23

Comments

lars toomre’s picture

lars toomre commented
Issue summary: View changes

Updated reference to API docs clean-up sub-issue.

mile23’s picture

mile23
Primary language English
Location Seattle, WA
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
commented
Status: Active » Needs review
StatusFileSize
new 1811874_2.patch446 bytes

And the teeniest patch of all.

mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented
Issue tags: +Quickfix
mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented

Still applies, still fixes all the type hinting errors in the Path module, according to phpcs, and it's ONLY ONE LINE. :-)

mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented

Still applies.

mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented
Issue summary: View changes
rishikant05’s picture

rishikant05 commented
Status: Needs review » Reviewed & tested by the community
Issue tags: -Quickfix +india, +SprintWeekend2015

Its working fine.

webchick’s picture

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

Committed and pushed to 8.0.x. Thanks!

  • webchick committed 159eef8 on 8.0.x 
    Issue #1811874 by Mile23, Lars Toomre: Add missing type hinting to Path...

Status: Fixed » Closed (fixed)

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