Check site-builder documentation for completeness

Created on 7 February 2023, almost 2 years ago
Updated 6 August 2023, over 1 year ago

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.

📌 Task
Status

Closed: cannot reproduce

Version

2.0

Component

Code

Created by

🇮🇳India Jay Jangid

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

Comments & Activities

  • Issue created by @Jay Jangid
  • @jay-jangid opened merge request.
  • Issue was unassigned.
  • Status changed to Needs review almost 2 years ago
  • 🇮🇳India Jay Jangid

    Created MR , please review.

    Thank you.

  • Assigned to raubi gaur
  • Issue was unassigned.
  • Status changed to RTBC almost 2 years ago
  • 🇮🇳India raubi gaur

    Thanks @Jay Jangid this mr solved above error.LGTM
    Moved to rtbc.

  • Status changed to Needs work almost 2 years ago
  • 🇦🇺Australia darvanen Sydney, Australia

    Hi Jay, Raubi,

    There is no bug or error caused by not implementing hook_help. The help section is there to give more information to site builders in particular on how the module functions and how they can set it up. It should contain instructions on how to configure or use the module aimed at that audience.

    A help file that only says:

    The purpose of these comments is to explain what is required by this method. This is one place where I think a much longer explanation is required. What does 'method' mean in this context for instance?

    does not do that.

    My preference is to provide contextual help wherever possible in field descriptions, widget descriptions etc. Only when there is something about the module that cannot be described in-situ should we reach for hook_help.

    I would encourage you to consider the site-builder documentation of this module as a whole and determine if it can be improved, with or without hook_help.

  • Status changed to Closed: cannot reproduce over 1 year ago
  • 🇦🇺Australia darvanen Sydney, Australia

    I do not think there is anything that can be provided by hook_help that can't be shown elsewhere instead. Happy to discuss if someone comes up with valuable content to place there, please feel free to reopen for that discussion. For now though, this is a "cannot reproduce" because I see no need for the task.

Production build 0.71.5 2024