Implement hook_help()

Created on 27 February 2020, over 4 years ago
Updated 16 July 2023, 12 months ago

Please Implement hook_help().

📌 Task
Status

Closed: won't fix

Version

1.0

Component

Code

Created by

🇮🇳India pavnish

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • 🇮🇳India Nupur Badola

    Module not present in D9.5.8

  • 🇺🇸United States greggles Denver, Colorado, USA

    I'm not sure every module needs a help screen.

    IMO this is "won't fix."

  • 🇮🇹Italy apaderno Brescia, 🇮🇹
    +      $output .= '<p>' . t('Paranoia can be uninstalled in the following ways: ') . '</p>';
    +      $output .= '<ul>';
    +      $output .= '<li>' . t('Using drush: drush pm-uninstall paranoia') . '</li>';
    +      $output .= '<li>' . t('Delete do module from the file system and clear site caches <em>or</em> truncate the cache_config table.') . '</li>';

    If hook_help() is only implemented to show how to uninstall the module, I would rather not implement it.
    Also, Delete do module does not grammatically make sense. Probably it is supposed to be Delete the module, but that is also wrong: A module is first uninstalled from the page to uninstall modules; then the files are removed.

    I agree with greggles: Not all the modules need a help screen, especially when the help screen just contains two sentences to describe the module.
    Somebody could say that Drupal core implements hook_help() on each of its modules, but Drupal core is a set of modules; in that case, it make sense to implement hook_help() even to just show a single sentence for each module. For a contributed project to do the same, it should have many sub-modules, not a single, main module.

  • Status changed to Needs work 12 months ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹
  • 🇮🇹Italy apaderno Brescia, 🇮🇹
  • Status changed to Closed: won't fix 12 months ago
  • 🇺🇸United States greggles Denver, Colorado, USA

    I think this is the right status at this point.

Production build 0.69.0 2024