Instead of saying "This sentence contains all the letters in the English alphabet", we should use

"The quick brown fox jumps over the lazy dog"

That sentence -actually- contains all of the letters in the English alphabet.

Totally just kidding.

Hook help should contain some useful information about what's going on and how it's happening. If we are not going to provide information in hook_help, I don't think we should implement hook_help.

For example, hook_help for the page_example could say something to the effect of "When a user goes to [defined menu entry], this function is going to be called, which returns this and that, which is rendered by Drupal's theme layer."

CommentFileSizeAuthor
#1 d6_page_example_960274.patch960 bytesmile23

Comments

mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented
Status: Active » Needs review
StatusFileSize
new d6_page_example_960274.patch960 bytes

I agree. No need for help text in this module since it never gets shown.

rfay’s picture

rfay
he,him
Primary language English
Location Palisade, CO, USA
commented

But wasn't cweagans saying "improve hook_help()" and you're saying "remove it"?

mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented

If you go to any of the paths defined by hook_help, it shows you 404. The paths defined by hook_menu show you the pages created by the module, and no help.

rfay’s picture

rfay
he,him
Primary language English
Location Palisade, CO, USA
commented
Status: Needs review » Fixed

OK, works for me. Committed: http://drupal.org/cvs?commit=467398

Thanks!

Status: Fixed » Closed (fixed)

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