Implement hook_help()

Created on 8 February 2023, over 1 year ago
Updated 20 November 2023, 7 months ago

Problem/Motivation

When you enable the module, the method hook_help is not implemented.

Steps to reproduce

Download and activate the module and visit it's help page.

Proposed resolution

Implement the hook_help and describe the functionality of the module and it's usage.

Remaining tasks

Implement hook_help.

📌 Task
Status

Closed: won't fix

Version

3.0

Component

Code

Created by

🇮🇳India Jay Jangid

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

Comments & Activities

  • Issue created by @Jay Jangid
  • @jay-jangid opened merge request.
  • Issue was unassigned.
  • Status changed to Needs review over 1 year ago
  • 🇮🇳India Jay Jangid

    Created MR , please review.

    Thank you.

  • Assigned to raubi gaur
  • Status changed to Needs work over 1 year ago
  • 🇦🇹Austria fago Vienna

    thank you for the patch. However this needs to be updated to custom_elements module in function name and comment: disabled_paste_on_login_help

  • 🇮🇳India adminazhar

    @fago yeah, the code seems for other module. Redoing it.

  • Status changed to Needs review over 1 year ago
  • 🇮🇳India adminazhar

    Kindly Review the latest MR changes.
    Re-did as per the suggestion.

  • 🇺🇦Ukraine mostepaniukvm

    Thanks for the contribution, I did a brief review of the related ticket first but closed it as duplicate when realized that we already have this.
    Bringing the same comment here.

    I checked the hook in PR and realized that the text seems just copied from README.md
    Maybe it's already better than nothing but I still think it's not complete and maybe we can improve it to make it more useful.
    Main concerns I see:
    - avoid documentation duplication;
    - make it really valuable and useful for site builders and developers;

    I checked and see some documentation on drupal.org that I'd like to check first
    https://www.drupal.org/node/632280#s-help-text-on-administration-pages
    https://www.drupal.org/node/632280#s-help-page
    https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

    Additionally, I will bring up this question at some future meeting

  • 🇮🇳India Raveen Kumar

    Hey folks, I have implemented the hook_help (using MR by Jay Jangid). And it works fine for me. As you can see my attached screenshots for reference. Please & thank you. I am using Drupal 9.5 version, PHP - 8.2.

  • Status changed to RTBC about 1 year ago
  • Status changed to Closed: won't fix 7 months ago
  • 🇳🇱Netherlands roderik Amsterdam,NL / Budapest,HU

    I separately reviewed this issue and now see I'm coming to the same conclusion as @mostepaniukvm. There is no useful help here that belongs inside the website (e.g. useful help for site builders when the module is installed). It's just a duplication of the text on the project page (which is useful for deciding whether you need the module, before you install it).

  • 🇳🇱Netherlands roderik Amsterdam,NL / Budapest,HU

    A note - I got a comment that a hook_help implementation would be useful for this module.

    That's true, but IMHO this issue hasn't done any work toward that (as can be seen from the function name copypaste in the initial commit).
    The grunt work is in compiling useful help text, not in copypasting said text into a hook_help implementation.

    So

    • setting this to RTBC after @mostepaniukvm is not helpful (on the contrary)
    • this issue would be open basically forever
    • if someone comes up with useful help text separately, for a hook_help implementation, then opens a new issue for it... no work is lost.
Production build 0.69.0 2024