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.59 KB

I uploaded the patch that adds hook_help file.
Thanks

apaderno’s picture

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

Part of the README.md file gives information that isn't much helpful after the module is installed. Instead of showing the content of that file, the implementation of hook_help() should output a totally different content.

alonaoneill’s picture

Should it be something like this?

alonaoneill’s picture

Status: Needs work » Needs review
krina.addweb’s picture

Status: Needs review » Reviewed & tested by the community
FileSize
11.72 KB
12.47 KB
29.83 KB

@alonaoneill, Thanks for all your work I checked it using simplytest.me & it is as per the mentioned standards.

Thanks

rodrigoaguilera’s picture

Status: Reviewed & tested by the community » Fixed

I guess having that help is better than nothing. Thanks for the contribution!

Status: Fixed » Closed (fixed)

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