Remove @todo tags at functions hook_theme_suggestions_HOOK() and hook_theme_suggestions_HOOK_alter() in file Theme.api.php [#2632996]

Problem/Motivation

Remove @todo tags for code examples at functions hook_theme_suggestions_HOOK_alter() and function hook_theme_suggestions_HOOK() in file Theme.api.php

Proposed resolution

Remaining tasks

User interface changes

none

API changes

Documentation only

Data model changes

none

Comment	File	Size	Author
#12	interdiff-2632996-8-12.txt	41.93 KB	Ankit Agrawal
#12	2632996-12.patch	907 bytes	Ankit Agrawal
#12	8.0.x: PHP 5.5 & MySQL 5.5 14,434 pass
#8	interdiff-2632996-7-8.txt	531 bytes	Ankit Agrawal
#8	2632996-8.patch	884 bytes	Ankit Agrawal
#8	8.0.x: PHP 5.5 & MySQL 5.5 14,428 pass
#5	interdiff-code-example-for-function-hook_theme_suggestions_HOOK_alter-2632996-3-5.txt	478 bytes	mohit_aghera
#5	code-example-for-function-hook_theme_suggestions_HOOK_alter-2632996-5.patch	856 bytes	mohit_aghera
#5	8.0.x: PHP 5.5 & MySQL 5.5 14,428 pass
#3	code-example-for-function-hook_theme_suggestions_HOOK_alter-2632996-3.patch	880 bytes	mohit_aghera
#3	8.0.x: PHP 5.5 & MySQL 5.5 14,428 pass

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

11 December 2015 at 04:06

Mac_Weber created an issue. See original summary.

Comment #2

Mac_Weber CreditAttribution: Mac_Weber as a volunteer commented 11 December 2015 at 04:07

Title:

Add code example for function hook_theme_suggestions_HOOK()

» Add code example for function hook_theme_suggestions_HOOK_alter()

bad title due to issue clone

Comment #3

mohit_aghera CreditAttribution: mohit_aghera as a volunteer and at Axelerant commented 11 December 2015 at 06:26

Status:

Active

» Needs review

File	Size
code-example-for-function-hook_theme_suggestions_HOOK_alter-2632996-3.patch	880 bytes
8.0.x: PHP 5.5 & MySQL 5.5 14,428 pass

Comment #4

hussainweb

English

CreditAttribution: hussainweb at Axelerant commented 11 December 2015 at 06:30

Status:

Needs review

» Needs work

+++ b/core/lib/Drupal/Core/Render/theme.api.php
@@ -711,6 +710,11 @@ function hook_theme_suggestions_HOOK_alter(array &$suggestions, array $variables
+  return $suggestions;

You don't need to return $suggestions. See bartik_theme_suggestions_form_alter for an example.

Comment #5

mohit_aghera CreditAttribution: mohit_aghera as a volunteer and at Axelerant commented 11 December 2015 at 06:36

File	Size
code-example-for-function-hook_theme_suggestions_HOOK_alter-2632996-5.patch	856 bytes
8.0.x: PHP 5.5 & MySQL 5.5 14,428 pass
interdiff-code-example-for-function-hook_theme_suggestions_HOOK_alter-2632996-3-5.txt	478 bytes

@hussainweb,
Thanks for pointing out the issue. Fixing in updated patch.

Comment #6

mohit_aghera CreditAttribution: mohit_aghera as a volunteer and at Axelerant commented 11 December 2015 at 06:37

Status:

Needs work

» Needs review

Comment #7

hussainweb

English

CreditAttribution: hussainweb at Axelerant commented 11 December 2015 at 06:57

Status:

Needs review

» Needs work

+++ b/core/lib/Drupal/Core/Render/theme.api.php
@@ -696,7 +696,6 @@ function hook_theme_suggestions_alter(array &$suggestions, array $variables, $ho
  *
- * @todo Add @code sample.

Extra line. You should remove the extra blank line so that there is just one blank line before @param.

Comment #8

Ankit Agrawal CreditAttribution: Ankit Agrawal as a volunteer commented 11 December 2015 at 07:22

File	Size
2632996-8.patch	884 bytes
8.0.x: PHP 5.5 & MySQL 5.5 14,428 pass
interdiff-2632996-7-8.txt	531 bytes

Updated the code. Please check.

Comment #9

mohit_aghera CreditAttribution: mohit_aghera as a volunteer and at Axelerant commented 11 December 2015 at 08:30

Status:

Needs work

» Needs review

Comment #10

Mac_Weber CreditAttribution: Mac_Weber as a volunteer commented 11 December 2015 at 11:53

Title:	Add code example for function hook_theme_suggestions_HOOK_alter()	» Remove @todo tags at functions hook_theme_suggestions_HOOK() and hook_theme_suggestions_HOOK_alter() in file Theme.api.php
Issue summary:	View changes
Status:	Needs review	» Needs work

I've created this issue while testing a new tool to post using the D.O API.
Actually, we already have code example there and I think we don't need anything more complex than what is already there.

We just need to remove the @todo tags.

Comment #11

star-szr

he/him

English

CreditAttribution: star-szr as a volunteer and at Northern Commerce commented 11 December 2015 at 17:44

Thanks!

Comment #12

Ankit Agrawal CreditAttribution: Ankit Agrawal as a volunteer commented 14 December 2015 at 10:36

File	Size
2632996-12.patch	907 bytes
8.0.x: PHP 5.5 & MySQL 5.5 14,434 pass
interdiff-2632996-8-12.txt	41.93 KB

Removed the @todo tags from hook_theme_suggestions[_HOOK]() and hook_theme_suggestions[_HOOK]_alter().

Comment #13

Ankit Agrawal CreditAttribution: Ankit Agrawal as a volunteer commented 14 December 2015 at 10:37

Status:

Needs work

» Needs review

Comment #14

joelpittet

English

Vancouver

CreditAttribution: joelpittet commented 14 December 2015 at 18:26

Status:

Needs review

» Reviewed & tested by the community

Thanks @Ankit Agrawal

Comment #15

Mac_Weber CreditAttribution: Mac_Weber as a volunteer commented 14 December 2015 at 19:45

Status:

Reviewed & tested by the community

» Closed (duplicate)

This issue is a duplicate of #2111079: Add @code sample and test coverage per hook_theme_suggestions[_HOOK]() and hook_theme_suggestions[_HOOK]_alter()
Closing this one in favor of the other because we already have patches there covering more stuff and also it replaces the tags by code in the documentation.