Implement hook_help()

Created on 10 March 2023, over 1 year ago
Updated 13 April 2024, 2 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 its help page.

Proposed resolution

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

๐Ÿ“Œ Task
Status

RTBC

Version

3.0

Component

Code

Created by

๐Ÿ‡ฎ๐Ÿ‡ณIndia Sahana _N

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

Merge Requests

Comments & Activities

  • Issue created by @Sahana _N
  • Status changed to Needs review over 1 year ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia sahil.goyal

    sahil.goyal โ†’ made their first commit to this issueโ€™s fork.

  • Merge request !7Resolve #3347194 "Implement hookhelp" โ†’ (Closed) created by sahil.goyal
  • Status changed to RTBC over 1 year ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia sahil.goyal

    Thanks @Sahana _N, the implemented hook looks great, patch applies cleanly, Created MR for easy merging, Moving to RTBC

  • Status changed to Needs work about 1 year ago
  • ๐Ÿ‡ฌ๐Ÿ‡งUnited Kingdom AdamPS

    Thanks, good idea and it's a good start. However the help is rather short, and it doesn't tell you much๐Ÿ˜ƒ. I plan to write a docs page soon, so maybe after I've done that it will help with this issue.

    Please put the help function at the end of the file, as it's not normally looked at during development. There is a typo "his project".

    The MR seems a bit mixed up.

  • First commit to issue fork.
  • Status changed to Needs review about 1 year ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia urvashi_vora Madhya Pradesh, India

    Hi @AdamPS,

    Based on your feedback

    Thanks, good idea and it's a good start. However the help is rather short, and it doesn't tell you much๐Ÿ˜ƒ. I plan to write a docs page soon, so maybe after I've done that it will help with this issue.

    Please put the help function at the end of the file, as it's not normally looked at during development. There is a typo "his project".

    The MR seems a bit mixed up

    For now, I have updated the existing MR and moved the help function at the end of file and also corrected the typo "his project".

    Moving it to Needs Review. Please verify the changes.

    Thanks

  • Status changed to RTBC about 1 year ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines paraderojether

    Hi @urvashi_vora

    I reviewed the MR and this changes " help function at the end of file and also corrected the typo "his project" " is verified, and it's working fine for me.

    Moving this to RTBC.
    Thank You.

  • Status changed to Needs work about 1 year ago
  • ๐Ÿ‡ฌ๐Ÿ‡งUnited Kingdom AdamPS

    Thanks. The MR is against the wrong branch - it needs to be on 3.x. I think the solution is to create a new MR.

    I have now created a docs page โ†’ . Some of this information should be added into the help text

    • 'help.page.manage_display' : general information
    • "Manage Display" page: explain about the formatters
    • "Theme settings" page: explain about the removed settings
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Raveen Kumar

    Hello Folks.
    I have reviewed & Implemented the MR! on my Drupal website having version 9.5, PHP version - 8.1
    The hook_help has been implemented successfully.
    I am attaching my patch (before,after,typosfixed.png) & screenshots for reference. Please have a look.
    Please & Thank You.

  • Status changed to Needs review about 1 year ago
  • Open in Jenkins โ†’ Open on Drupal.org โ†’
    Core: 9.5.x + Environment: PHP 7.3 & MySQL 5.7
    last update about 1 year ago
    2 pass
  • ๐Ÿ‡ฌ๐Ÿ‡งUnited Kingdom AdamPS
  • Status changed to RTBC about 1 year ago
  • ๐Ÿ‡ง๐Ÿ‡ทBrazil elber Brazil

    Hi moving to RTBC

    patch#11 passed in the tests
    Is applied cleanly
    is following phpcs
    Exlpalin the module

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Raveen Kumar

    @elber, Thanks for confirmation.

  • Status changed to Needs work 4 months ago
  • ๐Ÿ‡บ๐Ÿ‡ฆUkraine AstonVictor
  • Merge request !17Issue 3347194 - Add hook help โ†’ (Open) created by AstonVictor
  • Open in Jenkins โ†’ Open on Drupal.org โ†’
    Core: 9.5.x + Environment: PHP 7.3 & MySQL 5.7
    last update 4 months ago
    2 pass
  • Status changed to Needs review 4 months ago
  • ๐Ÿ‡บ๐Ÿ‡ฆUkraine AstonVictor

    Created a new MR with hook_help().

  • Status changed to Needs work 4 months ago
  • ๐Ÿ‡ฌ๐Ÿ‡งUnited Kingdom AdamPS

    Great that's a big improvement thanks.

    1) I feel that the comments at the top of the formatter classes are good for submitted and reply-to (perhaps I'm biased as I wrote them๐Ÿ˜ƒ). Please could we use those? They include a simple reference to the templates so we could then drop the templates section, which currently feel a bit technical for the display in the UI.

    2) Please could we make Formatters also a h3?

  • Open in Jenkins โ†’ Open on Drupal.org โ†’
    Core: 9.5.x + Environment: PHP 7.3 & MySQL 5.7
    last update 4 months ago
    2 pass
  • Open in Jenkins โ†’ Open on Drupal.org โ†’
    Core: 9.5.x + Environment: PHP 7.3 & MySQL 5.7
    last update 4 months ago
    2 pass
  • Status changed to Needs review 4 months ago
  • ๐Ÿ‡บ๐Ÿ‡ฆUkraine AstonVictor
  • Status changed to Needs work 4 months ago
  • ๐Ÿ‡ฌ๐Ÿ‡งUnited Kingdom AdamPS

    Thanks. The comments I mean are these. They give a rough indication of the template without too much detail and describes the default value. What do you think?

    * Formats a user reference as a sentence including the date, with an optional
    * user picture. The sentence is determined by the 'submitted' template, with a
    * default of "Submitted by on ".

    AND

    * Formats a comment reference as a sentence including the subject and author.
    * The sentence is determined by the 'in-reply-to' template, with a
    * default of "In reply to by ".

  • Status changed to RTBC 2 months ago
  • ๐Ÿ‡ฌ๐Ÿ‡งUnited Kingdom AdamPS

    I have very little time now for Drupal, so I will try to leave you as much freedom as possible. Either this or the first one are fine whatever you prefer.

Production build 0.69.0 2024