Problem/Motivation
From https://www.drupal.org/node/1354#templates:
Do not include
@ingroup themeable
in overridden template files in a theme -- only in the base version. Otherwise, theme-specific versions are documented the same way.
You could interpret "the base version" as from a base theme, but it's referring to the default output which (usually) comes from a module.
One of the reasons why we want to remove these lines from Classy's templates is so that Classy's templates won't be listed here as duplicates:
https://api.drupal.org/api/drupal/core%21modules%21system%21theme.api.ph...
Proposed resolution
Remove all the @ingroup themeable
lines (and preceding blank line) from Classy's .html.twig templates.
Example before/after code from Classy's page.html.twig:
Before:
* @see template_preprocess_page()
* @see html.html.twig
*
* @ingroup themeable
*/
#}
After:
* @see template_preprocess_page()
* @see html.html.twig
*/
#}
Remaining tasks
- Create patch
- Review patch
Beta phase evaluation
Issue category | Bug because it doesn't meet documentation standards |
---|---|
Issue priority | Normal |
Unfrozen changes | Unfrozen because it only changes documentation |
Prioritized changes | This is not a prioritized change for the beta phase. |
Disruption | No disruption for core or contrib. |
User interface changes
n/a
API changes
n/a
Comment | File | Size | Author |
---|---|---|---|
#3 | remove_ingroup-2452361-3.patch | 36.15 KB | sushyl |
Comments
Comment #1
star-szrAdding beta evaluation.
Comment #2
sushylComment #3
sushylRemoved all the instances of
in classy .html.twig files.
Comment #4
sushylComment #5
andypostgit grep ingroup core/themes/classy
shows nothing, looks readyComment #6
jhodgdonThanks for this! I clarified the documentation at https://www.drupal.org/coding-standards/docs#templates
Comment #7
star-szrMany, many thanks for that @jhodgdon :)
Comment #8
webchickLooks like a great improvement to help themers.
Committed and pushed to 8.0.x. Thanks!