Per the Module documentation guidelines, a module should Provide help text in the Drupal UI. This module is missing an implementation of hook_help(), but it does provide a fairly comprehensive README file, which can be included in hook_help() as a stop gap until something better can be created.

Documentation:
https://www.drupal.org/docs/develop/documenting-your-project/module-docu...
https://www.drupal.org/node/632280
Patch to follow, thanks!

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

alonaoneill created an issue. See original summary.

alonaoneill’s picture

Assigned: alonaoneill » Unassigned
Status: Active » Needs review
FileSize
1.78 KB

I uploaded the patch that adds hook_help file.
Thanks

apaderno’s picture

Version: 8.x-1.0 » 8.x-1.x-dev
Status: Needs review » Needs work

The content of the README.md file doesn't make it suitable for a hook_help() implementation, since it gives information on how to install the module, which is not anymore necessary when the module is installed.

alonaoneill’s picture

Should I just add "About" and "Usage" instead of refering it to README?
I can't really find good way to do it.

alonaoneill’s picture

Status: Needs work » Needs review
FileSize
1.23 KB

I uploaded hook_help() that doesn't require README.md file.

Willtg’s picture

Status: Needs review » Needs work

The 'a' tag from line 36 is not closed. Marking as NW

alonaoneill’s picture

Status: Needs work » Needs review
FileSize
1.29 KB

Made changes!

gg4’s picture

Status: Needs review » Needs work

Source order in patch is incorrect - @file and use need to be moved.

  • bonus committed 52598aa on 8.x-1.x
    Issue #3062635 by alonaoneill, bonus: Hook Help is missing
    
gg4’s picture

Status: Needs work » Fixed

Status: Fixed » Closed (fixed)

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