Closed (fixed)
Project:
Drupal core
Version:
6.x-dev
Component:
documentation
Priority:
Normal
Category:
Bug report
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
21 Dec 2009 at 09:23 UTC
Updated:
3 Jan 2014 at 01:08 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
jhodgdonAgreed. The doc headers for http://api.drupal.org/api/function/phptemplate_theme in both Drupal 6 and Drupal 7 need a clean up.
Since they are actually hook_theme() implementations, they should just say:
Implements hook_theme().
as the first line, then maybe have a blank line and some more information there. The current doc is lacking () after hook_theme(), so there is no link to hook_theme(), which would have said what the args were.
See http://drupal.org/node/1354 for standards. And please patch in 7.x first, then backport to 6.x.
Comment #2
jhodgdonLooking at this function, I don't think it needs doc beyond what is in hook_theme(). Our standard is only to document hook implementations extensively if they are doing something really noteworthy. So, here's a patch that standardizes the doc header for this function, and the other one in the same file (which completely lacked doc before).
Should be ported to D6 if accepted.
Comment #3
sobi3ch commentedI agree, the doc for hook_theme() is enought for it..
Comment #4
webchickCommitted to HEAD, thanks!
Comment #5
jhodgdonNeeds port to Drupal 6 as well.
Comment #6
sender commentedComment #7
sender commentedVersion for D6.
Comment #8
jhodgdonSigh. sender - I forgot to mention that in D6, all the other hook implementations are still following the old standard, so they say
Implementation of hook_foo().
rather than
Implements hook_foo().
So we should probably also do the same here.
Comment #9
sender commentedNo biggie. Here's a new version with the change you mentioned.
Comment #10
jhodgdonLooks good to me. Thanks!
Comment #11
gábor hojtsyThanks, committed.