Implement hook_help() [#3339806]

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.

Comment	File	Size	Author
#19	Geo_entity_After patch.PNG	15.66 KB	kavitha89
#19	Geo_entity_help.PNG	30.56 KB	kavitha89
#19	Geo_entity_before patch.PNG	15.26 KB	kavitha89
#17	Geo Entity.png	99.98 KB	nupur badola

Issue fork geo_entity-3339806

Show commands

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

Add & fetch this issue fork’s repository

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

Add & fetch this issue fork’s repository

3339806-Add-hook-help changes, plain diff MR !4
Check out this branch for the first time

Check out existing branch, if you already have it locally
1.0.x changes, plain diff MR !1
Check out this branch for the first time

Check out existing branch, if you already have it locally

About issue forks

Comments

Comment #1

7 February 2023 at 05:12

Shubham Rathore created an issue. See original summary.

Comment #2

7 February 2023 at 05:15

Shubham Rathore opened merge request !1

Comment #3

shubham rathore commented 7 February 2023 at 05:18

Assigned:	shubham rathore	» Unassigned
Status:	Active	» Needs review

Created MR for the issue.
Please review.
Thanks

Comment #4

Charchil Khandelwal commented 7 February 2023 at 13:18

Assigned:

Unassigned

» Charchil Khandelwal

I will review this.

Comment #5

Charchil Khandelwal commented 7 February 2023 at 13:19

Assigned:	Charchil Khandelwal	» Unassigned
Status:	Needs review	» Reviewed & tested by the community

MR !1 looks good to me.
So moving it to RTBC.

Thanks.

Comment #6

ekes commented 7 February 2023 at 13:38

Status:

Reviewed & tested by the community

» Needs work

If a `hook_help` is to be implemented in Drupal now it is only valuable if it includes the uses section as per documentation https://www.drupal.org/node/632280#s-help-page Repeating the description of the module in the help page about section is only visible once the module has been installed. Where you can see the description itself before installing.

There's an issue for https://www.drupal.org/project/geo_entity/issues/3339631 adding the usage documentation. You can work from the existing https://github.com/localgovdrupal/localgov_geo/wiki/Locations-Module-(LocalGov-Geo) documentation, but it needs updating for this version.

Also this patch includes 'single quoted content' inside a 'single quoted content' without escaping, so it will break

Comment #7

admin@azhark.com commented 25 February 2023 at 07:43

Title:	hook_help function missing in .module file	» Implement hook_help()
Issue summary:	View changes

Comment #8

elber

Portuguese, Brazil

Brazil

commented 27 February 2023 at 14:09

Assigned:

Unassigned

» elber

I will work on it

Comment #9

27 February 2023 at 14:18

elber opened merge request !4

Comment #10

elber

Portuguese, Brazil

Brazil

commented 27 February 2023 at 14:43

Assigned:	elber	» Unassigned
Status:	Needs work	» Needs review

Hi I just launched a suggestion to hook help please revise.

Comment #11

ekes commented 27 February 2023 at 14:53

Status:

Needs review

» Needs work

The latest version of the PR will just dump the unformatted raw markdown into the help page. Kinda scarey and not really great UX.

I will repeat what I said above, and try explaining again. If a hook_help() is to be useful it needs to include help for a user who has installed the module. You can't see the help until it's actually installed... you can see the module page and readme on the web before it's installed.

If people would like to be helpful. Please update the documentation for this module (see existing issue for links), and include this with appropriate links to pages within the users site.

Anything else is just a waste of everyones time.