Implement hook_help()

Created on 10 July 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 its help page.

Proposed resolution

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

Remaining tasks

Implement hook_help.

User interface changes

None.

API changes

None.

Data model changes

None.

📌 Task
Status

Active

Version

2.0

Component

Code

Created by

🇮🇳India dineshkumarbollu

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

Merge Requests

Comments & Activities

  • Issue created by @dineshkumarbollu
  • Merge request !20Resolve #3373487 "Implement hookhelp" → (Merged) created by dineshkumarbollu
  • Issue was unassigned.
  • Status changed to Needs review over 1 year ago
  • Status changed to RTBC over 1 year ago
  • Verified the MR20 on 9.5.10, help() is added. Added screenshots for reference, RTBC++.

  • Status changed to Needs work over 1 year ago
  • 🇨🇦Canada Nathan Tsai

    Thank you for creating this issue!

    Unfortunately, this `hook_help()` does not provide much more direction to users who click "help".

    We would need someone to write "step-by-step" instructions to create a simple email.

  • Status changed to Needs review over 1 year ago
  • 🇮🇳India dineshkumarbollu

    Hi

    I added the step-by-step instructions to create a simple email and project link to reach.

    Thanks

  • Status changed to Needs work over 1 year ago
  • 🇨🇦Canada Nathan Tsai

    Thank you for your contribution, @dineshkumarbollu!

    Added some comments in an MR: could you review them?

    https://git.drupalcode.org/project/send_emails/-/merge_requests/20

  • First commit to issue fork.
  • Status changed to Needs review over 1 year ago
  • Hello @Nathan Tsai ,hope you are doing well
    updated the changes addressed earlier .
    Kindly review the changes.
    Thank you

  • 🇮🇳India Bushra Shaikh

    I have applied MR !20 got below errors:

    git.drupalcode.org_project_send_emails_-_merge_requests_20.diff.patch:18: trailing whitespace.
     going to: `/admin/config/send_emails/emails/minimal/[email_template_machine_name]`
    git.drupalcode.org_project_send_emails_-_merge_requests_20.diff.patch:23: trailing whitespace.
    You can manually send an email to users with a role by first enabling the
    git.drupalcode.org_project_send_emails_-_merge_requests_20.diff.patch:26: trailing whitespace.
    Then, you can select the roles you can send to at the form:
    git.drupalcode.org_project_send_emails_-_merge_requests_20.diff.patch:31: trailing whitespace.
    `/admin/config/send_emails/manual/[email_template_machine_name]/[user_role]`
    git.drupalcode.org_project_send_emails_-_merge_requests_20.diff.patch:34: trailing whitespace.
    Note: currently, the `administrator`, `anonymous`, and `authenticated` user roles are disabled.
    error: patch failed: README.md:102
    error: README.md: patch does not apply
    error: patch failed: composer.json:12
    error: composer.json: patch does not apply
    error: patch failed: modules/send_emails_manual/src/Form/EmailManualSendByRole.php:142
    error: modules/send_emails_manual/src/Form/EmailManualSendByRole.php: patch does not apply
    error: patch failed: send_emails.info.yml:3
    error: send_emails.info.yml: patch does not apply
    error: patch failed: send_emails.services.yml:2
    error: send_emails.services.yml: patch does not apply
    error: patch failed: src/EmailApi.php:6
    error: src/EmailApi.php: patch does not apply
    error: patch failed: src/Form/EmailSettings.php:162
    error: src/Form/EmailSettings.php: patch does not apply
    
  • Status changed to RTBC over 1 year ago
  • 🇧🇷Brazil elber Brazil

    Hi MR applied cleanly to me (I'm using drupal 9.5 version)

    Hook help is didatic and well wrote

    News users of this module will to understand the module easier.

    Moving to RTBC.

  • 🇨🇦Canada Nathan Tsai

    @Bushra Shaikh and @elber, could you add the commands you used to apply the patch?

    Then, I can test both of them to ensure the patch works properly?

  • 🇧🇷Brazil elber Brazil

    I didn't apply the change as a patch. I just used the MR

    Steps

    git remote add send_emails-3373487 git@git.drupal.org:issue/send_emails-3373487.git
    git fetch send_emails-3373487
    
    
    git checkout -b '3373487-implement-hookhelp' --track send_emails-3373487/'3373487-implement-hookhelp'

    it worked to me.

  • 🇨🇦Canada Nathan Tsai

    Thank you everyone for your hard work! (And patience)

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

Production build 0.71.5 2024