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!

Comments

alonaoneill created an issue. See original summary.

alonaoneill’s picture

Assigned: alonaoneill » Unassigned
Status: Active » Needs review
StatusFileSize
new1.73 KB

I uploaded the patch that adds hook_help file.
Thanks

wengerk’s picture

Status: Needs review » Needs work

Hey @alonaoneill, thanks for helping us on this "on-heavy" development projet !

I would suggest only 1 change about the first @file comment which is not very helpfull for now.

  • +/**
    + * @file
    + * Loco Translate provides a normalised way to collect & gather
    + * internationalisation assets & translations into & from Loco.
    + * Ensure an enhanced Developer Experience (DX) when dealing with translations
    + * & multilingual websites.
    + */

    I would prefer something like

    /**
     * @file
     * Contains includes hook to generate help page.
     */

    What do you think ?

alonaoneill’s picture

Status: Needs work » Needs review
StatusFileSize
new1.54 KB

Okay. Made changes.

wengerk’s picture

Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

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