Quantcast
Channel: Issues for Drupal core
Viewing all articles
Browse latest Browse all 295807

Add missing type hinting to System module docblocks

$
0
0

This is a sub-issue of #1800046: [META] Add missing type hinting to core docblocks focused on correctly adding @param and @return type hinting to the System 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:

You can use phpcs this way to check for remaining @param and @return hint errors:

phpcs --standard="Drupal" --extensions="module/php,inc/php,php" --report-csv --ignore="core/modules/system/tests,core/modules/system/src/Tests" core/modules/system/ | grep -F $'Missing param\nReturn type missing'

Note that this uses --ignore to exclude test files, since those are handled in another issue: #2651280: Add missing type hinting to System module TEST docblocks

Related sprint issues:

Sprint Topic Sub Issue
#1518116: [meta] Make Core pass Coder Review#1533400: Make system module (except tests subdirectory) pass Coder Review
#1310084: [meta] API documentation cleanup sprint#1326664: Clean up API docs for system module (excluding subdirectories)

Viewing all articles
Browse latest Browse all 295807

Trending Articles



<script src="https://jsc.adskeeper.com/r/s/rssing.com.1596347.js" async> </script>