Created on 28 April 2023, over 1 year ago
Updated 22 December 2023, 11 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 the help page does not exist.

Proposed resolution

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

Remaining tasks

Implement hook_help.

Thanks

📌 Task
Status

Needs work

Version

2.0

Component

Code

Created by

🇮🇳India prashant.c Dharamshala

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

Merge Requests

Comments & Activities

  • Issue created by @prashant.c
  • First commit to issue fork.
  • Merge request !5issues-3357091-add-hook-help-fixes. → (Open) created by viren18febS
  • Status changed to Needs review 12 months ago
  • 🇮🇳India viren18febS

    I have added MR for hook_help, please review.

  • Verified MR5 on 9.5.x, the hook_help is added. Added screenshots for reference, RTBC++

  • 🇮🇳India prashant.c Dharamshala

    @Tanuja Bohra

    Thanks for making the efforts to test it however IMHO screenshots were not required in this case.

    Thanks!

  • Status changed to Needs work 11 months ago
  • 🇮🇳India Anjali Mehta

    I have reviewed the MR5, and the hook only returns the content of the README.md file. However, this is not sufficient as it should provide a more helpful overview for other developers and users. Instead of just including the README content, the hook should incorporate an informative help page with a standardized structure.

    The updated help page should include the following sections:

    About section
    giving a brief overview of what the module does, starting with text like "The Foo Bar module [verb]", and finishing with a standardized link to the module's online documentation.
    Uses section
    giving details of module functionality and explaining what users can do, and links to the URLs where each specific functionality can be accessed.

    By incorporating these improvements, the help page will become more informative and user-friendly.

    Changing the status back to NW
    Thank you.

Production build 0.71.5 2024