Implement hook_help()

Created on 28 January 2023, over 1 year ago
Updated 17 July 2023, 12 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 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

Needs review

Version

1.0

Component

Code

Created by

🇮🇳India vishal.kadam Mumbai

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

Comments & Activities

  • Issue created by @vishal.kadam
  • 🇮🇳India vishal.kadam Mumbai

    This patch solves the task.

  • Status changed to Needs review over 1 year ago
  • Status changed to Needs work over 1 year ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    The first two sentences taken from the project page would be more correct.

  • Status changed to Needs review over 1 year ago
  • 🇮🇳India vishal.kadam Mumbai

    Updated patch.

  • Status changed to Needs work over 1 year ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹
    +      $output .= '<p>' . t('Maintenance IP Whitelist module you to set a whitelist of IP addresses that are allowed to bypass the maintenance mode of a website.') . '</p>';
    +      $output .= '<p>' . t('This is particularly useful if, as an site administrator, you need to test specific workflows that are built for anonymous users and requires you to browse the website without being connected.') . '</p>';
    +      $output .= '<p>' . t('Visit the <a href=":project_link">Project page</a> on Drupal.org for more information.', [
    

    The first translatable text does not have the article for the subject and the verb.
    The second translatable text is using the third singular person for a plural noun (workflows).
    The third translatable text uses the capital case for a word that is not at the beginning of a sentence (Project).

  • Status changed to Needs review over 1 year ago
  • Status changed to Needs work over 1 year ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹
    +      $output .= '<p>' . t('This is particularly useful if a site administrator need to test specific workflows that are built for anonymous users and needs to browse the website without being connected.') . '</p>';
    

    If and needs to browse the website without being connected is referred to workflows, needs is wrong. If instead and needs to browse the website without being connected is referred to a site administrator, needs is correct.

    site administrator is singular, so need is wrong.

  • First commit to issue fork.
  • @adminazhar opened merge request.
  • Status changed to Needs review over 1 year ago
  • Status changed to RTBC about 1 year ago
  • 🇮🇳India Nupur Badola

    Patch is working and marking it to RTBC.

  • Status changed to Needs work about 1 year ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹
  • First commit to issue fork.
  • Status changed to Needs review about 1 year ago
  • 🇮🇳India sourabhjain

    Resolved all the reviews provided on PR. Please review.

  • 🇮🇳India kavitha@specbee.com

    Verified the MR1 on 9.5.9 & help() is added. Added screenshots for reference & it can be moved to RTBC
    Thank you.

  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    There is no need to show that the hook_help() implementation is recognized by Drupal. As long as the hook implementation is using the correct name, Drupal will recognize that hook.

Production build 0.69.0 2024