How to show help text

Hey, this is something that has not been working since the beginning. The Commerce API accepts the 'help' text as part of its profile info hook, but does not thing with it. I haven't checked lately if this has changed at all, but if you're not seeing it show up then I doubt it is fixed.

I will probably be doing some maintenance work on the module this week, so I'll check into it again, but in the meantime or until it is fixed you could add a markup field to the profile and style it to look like help text. That is my best suggestion for you.

cheers.

To answer your question as to how to show help text that you have entered on the profile type settings, I've been digging around and although not totally obvious from the commerce API description ("a translatable help message to be displayed at the top of the administrative add / edit form for profiles of this type"), it seems that commerce tries to display the help text through hook_help. This means that if you have the drupal core help module enabled it should show up in the region you have the system help block configured to display.

However, I have been testing this and the help text does not show. Although other hook_help help texts show up from other modules on other pages. I'm guessing this is an issue in the commerce module and will require some more digging.

Did a little more digging and it was a very quick fix. I contributed a patch back for the commerce module. If you were so inclined you could help move this along if you test the patch in the posted issue and mark it as RBTC if it works for you.

I will leave this issue open for now, because now that I actually know how this is supposed to work I do need to update the documentation for this module. The documentation for the commerce module should also be updated to make it better know where the help text should show up.

Looks like the patch in the commerce issue was committed so I will mark this issue as fixed.

I have updated the descriptions for the help and description parameters on the add / edit profile type forms so they will be more descriptive in the next release of this module.

For future people looking to figure out what these parameters do, the text you enter as the 'help' requires the core help module or any other module invoking hook_help to be enabled. Also, the system help block needs to be configured in your admin theme to display in a visible region. It is the system help block that displays the help text. The help text only shows up on the admin page for adding a new profile of a particular type.

So for example: /admin/commerce/customer-profiles/add/test-profile

It does not show up during checkout.