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.

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

Jay Jangid created an issue. See original summary.

jay jangid’s picture

Assigned: jay jangid » Unassigned
Status: Active » Needs review

Created MR , please review.

Thank you.

raubi gaur’s picture

raubi gaur’s picture

Assigned: Unassigned » raubi gaur
fago’s picture

Status: Needs review » Needs work

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

admin@azhark.com’s picture

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

admin@azhark.com’s picture

Status: Needs work » Needs review

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

mostepaniukvm’s picture

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

raveen_thakur51’s picture

StatusFileSize
new29.4 KB
new20.3 KB

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.

raveen_thakur51’s picture

Status: Needs review » Reviewed & tested by the community
roderik’s picture

Status: Reviewed & tested by the community » Closed (won't fix)

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).

roderik’s picture

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 commented, is clearly ignoring him and 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.