Problem/Motivation

The module does not implement hook_help(), which helps users understand the module and it is recommended.

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

noorulshameera created an issue. See original summary.

noorulshameera’s picture

Status: Active » Needs review
StatusFileSize
new1.25 KB

Adding patch to implement hook_help() function.

itsprashantbais’s picture

StatusFileSize
new26.41 KB
new25 KB

Hi @noorulshameera,
patch on comment #2 works fine for me on drupal 9.5.

Charchil Khandelwal made their first commit to this issue’s fork.

charchil khandelwal’s picture

Created MR for this issue.
Please review.

prashant.c’s picture

Status: Needs review » Needs work

Please take the text from the README file of the module in the hook_help().

admin@azhark.com’s picture

I disagree with you @Prashant.c, the help page shows after installation, so there is no need to add the installation instructions etc in the help page.
It would be better to have a better help page by cleanup up few headings from readme and add better text.

prashant.c’s picture

@adminazhar README file does not have only "installation" instructions it also contains "configuration" and "troubleshooting" instructions as well therefore it is a good idea to display the content from the README file for consistency also.
Moreover, there is no harm in showing "installation" instructions also along with other valuable details.

However, if it is not read from the README file then please add all the possible configuration details provided by the module otherwise help page will not be beneficial to someone.

himanshu_jhaloya’s picture

Assigned: Unassigned » himanshu_jhaloya

himanshu_jhaloya’s picture

Assigned: himanshu_jhaloya » Unassigned
Status: Needs work » Needs review
prashant.c’s picture

Status: Needs review » Reviewed & tested by the community

We can push it in the next release along with some other features.

prashant.c’s picture

Status: Reviewed & tested by the community » Fixed

Thanks to all the contributors.

Status: Fixed » Closed (fixed)

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