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

Reference: https://www.drupal.org/core/beta-changes
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

Files: 
CommentFileSizeAuthor
#3 remove_ingroup-2452361-3.patch36.15 KBsushyl
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 89,194 pass(es). View

Comments

Cottser’s picture

Issue summary: View changes

Adding beta evaluation.

sushyl’s picture

Assigned: Unassigned » sushyl
sushyl’s picture

Issue tags: +#drupalgoa2015
FileSize
36.15 KB
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 89,194 pass(es). View

Removed all the instances of

 *
 * @ingroup themeable

in classy .html.twig files.

sushyl’s picture

Assigned: sushyl » Unassigned
Status: Active » Needs review
andypost’s picture

Status: Needs review » Reviewed & tested by the community

git grep ingroup core/themes/classy shows nothing, looks ready

jhodgdon’s picture

Thanks for this! I clarified the documentation at https://www.drupal.org/coding-standards/docs#templates

Cottser’s picture

Many, many thanks for that @jhodgdon :)

webchick’s picture

Status: Reviewed & tested by the community » Fixed

Looks like a great improvement to help themers.

Committed and pushed to 8.0.x. Thanks!

  • webchick committed a74e19a on 8.0.x
    Issue #2452361 by sushyl, Cottser: Remove "@ingroup themeable" from all...

Status: Fixed » Closed (fixed)

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