Implement hook_help()

Created on 6 February 2023, over 1 year ago
Updated 4 April 2024, 3 months ago

Problem/Motivation

Implement hook_help()

Steps to reproduce

When you enable the module, the method hook_help is not implemented.

Proposed resolution

Download and activate the module and visit it's help page.

Remaining tasks

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

๐Ÿ“Œ Task
Status

Fixed

Version

3.0

Component

Code

Created by

๐Ÿ‡ฎ๐Ÿ‡ณIndia dineshreddymathuku Bangalore

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

Merge Requests

Comments & Activities

  • Issue created by @dineshreddymathuku
  • Status changed to Needs review over 1 year ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia dineshreddymathuku Bangalore

    Created MR for the issue.
    Please review.
    Thanks

  • Status changed to Needs work about 1 year ago
  • After applying the MR6, getting these error:

    error: patch failed: modules/rest_views_geo/rest_views_geo.info.yml:5
    error: modules/rest_views_geo/rest_views_geo.info.yml: patch does not apply
    error: patch failed: modules/rest_views_revisions/rest_views_revisions.info.yml:5
    error: modules/rest_views_revisions/rest_views_revisions.info.yml: patch does not apply
    error: patch failed: modules/rest_views_search_api/rest_views_search_api.info.yml:5
    error: modules/rest_views_search_api/rest_views_search_api.info.yml: patch does not apply
    error: patch failed: rest_views.info.yml:1
    error: rest_views.info.yml: patch does not apply
    error: patch failed: modules/rest_views_geo/rest_views_geo.info.yml:1
    error: modules/rest_views_geo/rest_views_geo.info.yml: patch does not apply
    error: patch failed: modules/rest_views_revisions/rest_views_revisions.info.yml:1
    error: modules/rest_views_revisions/rest_views_revisions.info.yml: patch does not apply
    error: patch failed: modules/rest_views_search_api/rest_views_search_api.info.yml:1
    error: modules/rest_views_search_api/rest_views_search_api.info.yml: patch does not apply
    6.patch:1064: new blank line at EOF.
    +

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States nicxvan

    I am no longer supporting the 2.x branch, I'll update the merge request with 3.0.x and take a look.

  • Open in Jenkins โ†’ Open on Drupal.org โ†’
    Core: 10.2.x + Environment: PHP 8.2 & MySQL 8
    last update 5 months ago
    4 pass
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States nicxvan

    This MR seems to be just copying the hook_help from eck_bundle_permissions

    Please update it to be specific to rest_views including the help text.

  • First commit to issue fork.
  • Status changed to Needs review 3 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia shivamsen_12579 Bhopal

    updated the hook_help with help text.
    please review.

  • Pipeline finished with Failed
    3 months ago
    Total: 242s
    #117870
  • Status changed to Postponed: needs info 3 months ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States nicxvan

    Thanks, do you have any examples of other modules doing their help text like this?

    I think it's clever, but I'm not sure this is the standard way Drupal contrib provides help text.

    The only module I see that does something similar is this one: https://www.drupal.org/project/module_instructions โ†’ but it uses check_markup for security and renders a markup field. Also critically that module outputs html in it's own hook help.

    Let me ask for another review before I ask for any changes, but if there are other modules doing this please provide those examples.

  • Status changed to Needs work 3 months ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States nicxvan

    After looking at this further, while I appreciate the elegance of not maintaining content in two places, I think it's more secure to just follow the convention and write hook help manually with some html. I don't think we need the full readme, just some pointers that you think would help a new user.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Jasjeet Kaur Brar

    Jasjeet Kaur Brar โ†’ made their first commit to this issueโ€™s fork.

  • Status changed to Needs review 3 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Jasjeet Kaur Brar

    @nicxvan , Please review now. And Thank You!!

  • Pipeline finished with Success
    3 months ago
    Total: 149s
    #121995
  • Status changed to Fixed 3 months ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States nicxvan

    Thank you for your effort to contribute to Drupal. These types of changes may fall under the credit abuse policy: https://www.drupal.org/drupalorg/docs/marketplace/abuse-of-the-contribut... โ†’
    If I merge this change I will not be be providing credit for this issue. Creating issues en masse is discouraged for low-effort changes that do not provide a bugfix, add a feature or otherwise provide value to the project the change is proposed to.

    For guidelines on etiquette for Drupal contributions:
    https://www.youtube.com/watch?v=lu7ND0JT-8A
    https://docs.google.com/presentation/d/1jvU0-9Fd4p1Bla67x9rGALyE7anmzjhQ...
    https://www.youtube.com/watch?v=0K0uIgKaVNQ
    https://www.drupal.org/docs/develop/issues/issue-procedures-and-etiquett... โ†’
    https://www.drupal.org/drupalorg/docs/marketplace/abuse-of-the-contribut... โ†’

    This issue may have been reported to the site moderation queue for review.

    If this is your first time seeing this feel free to comment, I would be happy to provide more resources for your contributions to be meaningful and receive credit.

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States nicxvan

    After further consideration I believe I should provide credit for a few users on this ticket as their contribution came after a direct comment by me about the patch.

    In general these types of tickets are a fine line whether module maintainers find them helpful.
    Since I requested changes I will provide credit to the users that responded to my requests.

  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.69.0 2024