Follow-up to #1800174: Add missing type hinting to User module docblocks Not all hinting was addressed in that issue. This patch should be very small. :-)
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 Node 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
- Attempt to apply the patch to see if it needs a reroll.
- Use the phpcs one-liner to evaluate whether all the relevant standards errors have been resolved: https://gist.github.com/paul-m/227822ac7723b0e90647
- Look at each change and determine whether the type hint is correct.
Comment | File | Size | Author |
---|---|---|---|
#4 | 2649216_4.patch | 1.54 KB | Mile23 |
Comments
Comment #2
Mile23Comment #3
Mile23Related: #2311219: Fix hook_user_format_name_alter() documentation and stop referring to user_format_name() might require a re-roll.
Comment #4
Mile23The patch.
Comment #5
Mile23As pointed out elsewhere, these documentation changes can occur in 8.0.x.
Patch in #4 still applies to 8.0.x.
Comment #14
Kristen PolThanks for the issue and patch. This has been fixed in #2954825: Update the user.api.php documentation and add the correct type hints in the user's hooks implementations and #2721901: Fix Drupal.Commenting.FunctionComment.MissingParamName.