This issue has novice tasks. If you are an experienced core developer and have multiple commit mentions, please review novices' work on these tasks rather than doing them yourself. Feedback from experienced contributors is valued.

Problem/Motivation

The listing at https://api.drupal.org/api/drupal/core%21modules%21system%21theme.api.ph... includes templates defined in core themes, and it shouldn't. To be more helpful it should only list the default definition of each piece of markup/output: https://drupal.org/node/1823416#docblock

You can check Drupal 7's .tpl.php files as a comparison.

Some or all core theme templates (templates under /core/themes only) include the line @ingroup themeable, which should only be added to default theme output (in core this means output/templates defined by a module).

Proposed resolution

Remove the @ingroup themeable and line above from all core theme templates:

 *
 * @ingroup themeable

Remaining tasks

User interface changes

n/a

API changes

n/a

CommentFileSizeAuthor
#6 drupalcore-removed_ingroup-2226185-6.patch4.22 KBgalooph
#2 drupalcore-removed_ingroup-2226185-1.patch4.18 KBfilijonka
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

star-szr’s picture

star-szr
he/him
Primary language English
CreditAttribution: star-szr commented
Title: Remove @ingroup themeable from preprocess function docblocks » Remove @ingroup themeable from core theme Twig template docblocks

Oops, copy+pasted the issue title and didn't change it.

filijonka’s picture

filijonka CreditAttribution: filijonka commented
FileSize
drupalcore-removed_ingroup-2226185-1.patch4.18 KB
filijonka’s picture

filijonka CreditAttribution: filijonka commented
Assigned: Unassigned » filijonka
galooph’s picture

galooph CreditAttribution: galooph commented
Status: Active » Needs work

Hi filijonka,

Thanks for the patch!

Looking good, but you seem to be adding an extra blank line here

diff --git a/core/themes/bartik/templates/field--taxonomy-term-reference.html.twig b/core/themes/bartik/templates/field--taxonomy-term-reference.html.twig
index f09143e..627b2fd 100644
--- a/core/themes/bartik/templates/field--taxonomy-term-reference.html.twig
+++ b/core/themes/bartik/templates/field--taxonomy-term-reference.html.twig
@@ -14,8 +14,7 @@
  *
  * @see template_preprocess_field()
  * @see bartik_preprocess_field()
- *
- * @ingroup themeable
+
  */

Also, it would be handy if you could list the themes/functions that you have removed the @ingroup themeable from, similar to the list in the similar issue Remove @ingroup themeable from preprocess function docblocks

When you update your patch, change the issue status to 'Needs review' and then the testbot will test your patch.

galooph’s picture

galooph CreditAttribution: galooph commented
Assigned: filijonka » galooph
galooph’s picture

galooph CreditAttribution: galooph commented
Status: Needs work » Needs review
FileSize
drupalcore-removed_ingroup-2226185-6.patch4.22 KB

Updated the patch from #2 to remove the blank line.

As per the Themeable group listing, the @ingroup themeable has been removed from:

Bartik:

  • core/themes/bartik/templates/block--system-branding-block.html.twig
  • core/themes/bartik/templates/comment.html.twig
  • core/themes/bartik/templates/field--taxonomy-term-reference.html.twig
  • core/themes/bartik/templates/maintenance-page.html.twig
  • core/themes/bartik/templates/node.html.twig
  • core/themes/bartik/templates/page.html.twig

Seven:

  • core/themes/seven/templates/install-page.html.twig
  • core/themes/seven/templates/maintenance-page.html.twig
  • core/themes/seven/templates/page.html.twig
star-szr’s picture

star-szr
he/him
Primary language English
CreditAttribution: star-szr commented
Status: Needs review » Reviewed & tested by the community

Looks great, thank you @filijonka and @galooph!

webchick’s picture

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

Nice catch. Thanks for making our docs clearer. :)

Committed and pushed to 8.x. Thanks!

  • Commit d193c97 on 8.x by webchick: 
    Issue #2226185 by galooph, filijonka, Cottser: Remove @ingroup themeable...

Status: Fixed » Closed (fixed)

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