Implement hook_help()

Created on 16 February 2023, almost 2 years ago
Updated 4 April 2023, over 1 year ago

Problem/Motivation

When you enable the module, Drupal does not show the online help for the module.

Steps to reproduce

Download and activate the module and visit its help page.

Proposed resolution

Implement hook_help() to describe the module functionality and its usage.

Feature request
Status

RTBC

Version

4.0

Component

Code

Created by

🇮🇳India dineshkumarbollu

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

Comments & Activities

  • Issue created by @dineshkumarbollu
  • @dineshkumarbollu opened merge request.
  • Assigned to dineshkumarbollu
  • Status changed to Needs review almost 2 years ago
  • 🇮🇳India dineshkumarbollu

    Hi Team

    I created MR for this issue, please Review.

    Thanks

  • Issue was unassigned.
  • Status changed to Needs work almost 2 years ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    The issue summary still needs to describe what the proposed change is, and why it is proposed.

  • @adminazhar opened merge request.
  • 🇮🇳India adminazhar

    Added Issue Summary and raised new MR.
    Kindly Review: Merge request !9

  • Status changed to Needs review almost 2 years ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹
  • Status changed to Needs work almost 2 years ago
  • 🇩🇪Germany FeyP

    Thank you for filing this issue and for working on it.

    @adminazhar Please don't open a new MR when you just want to add a one line change. You can get push access to any existing MR and just push your commits on top of that. There might be a few cases where a new MR might actually make sense, like if there are multiple different ways to fix an issue and it there isn't a consensus in the issue about the best fix. But this is definitely not one of those cases. With multiple MRs it is really difficult to review the changes you made compared to just updating an existing MR and it adds unnecessary noise to the issue. Can you plase close your MR and push any changes on top of the existing MR?

    Some more issues I have with both MRs in the current state:

    1. I don't think the current help text adds a lot of value to users. We could just copy more text from the README or the release notes, but that would mean a lot of unnecessary duplication and more work to keep everything in sync and has a potential to miss updating one of the sources, when needed. We could also just add a reference to the project page or README, but users should already be aware of it, so I don't think we should do that. I'm just not convinced that we really need to implement this hook.
    2. I don't like the switch statement, because it is loosely typed. Not such an issue here, but I would rather replace this with an if and return early to save unnecessary indentation.
  • Assigned to akshaydalvi212
  • 🇮🇳India akshaydalvi212

    I will implement hook_help() which will refer to the README.md file.

  • Issue was unassigned.
  • Status changed to Needs review over 1 year ago
  • 🇮🇳India akshaydalvi212

    Updated the implementation of hook_help().
    attached is the screenshot of the help page which will fetch the content from the README.md file.
    kindly review.

  • Assigned to Mahima_Mathur23
  • 🇮🇳India Mahima_Mathur23

    Reviewed the MR. Help text is available in the module. Attaching screenshot for reference.

  • Issue was unassigned.
  • Status changed to RTBC over 1 year ago
Production build 0.71.5 2024