During project application review I've found that somebody used hook_menu instead hook_help for displaying help text.
This user followed filter_example module:

http://drupal.org/node/1913566

I created a patch which replaces hook_menu with hook_help in filter_examples module.

CommentFileSizeAuthor
filter_example_hook_help.patch1.67 KBPawelR

Comments

mile23’s picture

Title: Using hook_menu for displaying help is not best practice » Add hook_menu to Filter Example
Status: Needs review » Fixed

Thanks, Pawel.

In the context of Examples, we want a page with help on it. It's much easier to get to the point that way, rather than requiring that people remember that there's a help system, and then look through to see if there's anything about the module they just installed.

It's true that the help system is a better place for help, as a best practice. However, for Examples we want both. :-)

So I left the hook_help() in, put the hook_menu() back and changed the help text itself to be a little more legible. Also made it a little more clear which filters are coming from the example module.

And boom: http://drupalcode.org/project/examples.git/commitdiff/22a636654ea598cfe0...

Thanks again, Pawel. :-)

Status: Fixed » Closed (fixed)

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