To avoid misunderstandings about the scope and proper use of this function, it would be useful to expand slightly on the documentation and explain where it can and cannot be called.

I took the liberty of blogging an overview of the use here - feel free to copy and paste chunks of it, if it is correct:
http://www.drupaler.co.uk/blog/path-theme-module/73

CommentFileSizeAuthor
#5 path_to_theme_docs.head_.b.patch987 bytesdvessel
#5 path_to_theme_docs.6.b.patch1002 bytesdvessel
#1 path_to_theme_docs.head_.patch982 bytesdvessel
#1 path_to_theme_docs.6.patch997 bytesdvessel

Comments

dvessel’s picture

dvessel commented
Category: feature » bug
Status: Active » Needs review
StatusFileSize
new path_to_theme_docs.6.patch997 bytes
new path_to_theme_docs.head_.patch982 bytes

The explanation was way off. It made sense in 5. Starting with 6 it's very misleading.

Anonymous’s picture

Anonymous (not verified) commented
Component: theme system » documentation
Category: bug » task
moshe weitzman’s picture

moshe weitzman commented
Status: Needs review » Reviewed & tested by the community

Helpful - thanks.

dries’s picture

dries commented
Status: Reviewed & tested by the community » Needs work

Please wrap the lines consistently, and re-roll.

It might also be useful to add one sentence explaining why this function is used/useful.

dvessel’s picture

dvessel commented
Status: Needs work » Reviewed & tested by the community
StatusFileSize
new path_to_theme_docs.6.b.patch1002 bytes
new path_to_theme_docs.head_.b.patch987 bytes

The lines were odd because I tried to keep them within 78 characters per line. Not sure if there was a standard to this but that's what I see in most other areas of core.

It did have a one sentence explanation.

dries’s picture

dries commented
Status: Reviewed & tested by the community » Fixed

Committed to CVS HEAD and DRUPAL-6. Thanks!

Anonymous’s picture

Anonymous (not verified) commented
Status: Fixed » Closed (fixed)

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