Provide a hook_help() in .module file for the developers to access help pages in the module.

CommentFileSizeAuthor
#18 ckeditor_details_MR!8-after.png168.13 KBroberttabigue
#18 ckeditor_details_MR!8-before.png175.54 KBroberttabigue
#14 ckeditor_details-afterMR!8.png184.92 KBroberttabigue
#14 ckeditor_details-beforeMR!8.png52.23 KBroberttabigue

Issue fork ckeditor_details-3336825

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

Pracheth created an issue. See original summary.

Pracheth opened merge request !3

Pracheth’s picture

Pracheth commented
Assigned: Pracheth » Unassigned
Status: Active » Needs review
sahilgidwani’s picture

sahilgidwani commented
Status: Needs review » Reviewed & tested by the community

I have reviewed the PR and it looks perfect to me.
Moving the issue to RTBC.

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Version: 2.0.3 » 2.x-dev
Status: Reviewed & tested by the community » Needs work

No, showing the README.txt file content is not what that hook should do, since:

  • The README.txt file contains information that is only helpful before installing the module
  • The text is not translatable

elber made their first commit to this issue’s fork.

elber’s picture

elber
Primary language Portuguese, Brazil
Location Brazil
commented
Status: Needs work » Needs review

Hi I added a suggestion to hook help, please revise.

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Title: hook_help() is missing in .module file » hook_help() is not implemented
Status: Needs review » Needs work

The text explains how to use the module, but it does not describe what the module does.

elber’s picture

elber
Primary language Portuguese, Brazil
Location Brazil
commented
Status: Needs work » Needs review

Hi please revise

dydave made their first commit to this issue’s fork.

dydave opened merge request !8

dydave changed the visibility of the branch 3336825-hookhelp-is-missing to hidden.

dydave’s picture

dydave commented
Version: 2.x-dev » 2.1.x-dev

It seems development has moved to the 2.1.x branch now, therefore:

Created the new merge request MR !8 above at #11 based on the previous merge request but rebased for branch 2.1.x.

Updated the previous merge request to be hidden.

This MR could use a round of textual/content review and overall testing.

Any feedback, comments, reviews or suggestions would be greatly appreciated.
Thanks in advance!

roberttabigue’s picture

roberttabigue commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new ckeditor_details-beforeMR!8.png52.23 KB
new ckeditor_details-afterMR!8.png184.92 KB

Hi @dydave,

I have applied your latest MR to the CKeditor Details Accordion module against 2.1.x-dev and confirmed that the help text at /admin/help/ckeditor_details is now updated and other information is also implemented.

Please see the attachments for reference.

I'm marking this now as 'RTBC'.

Thank you!

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Status: Reviewed & tested by the community » Needs work
avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Assigned: Unassigned » avpaderno
avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Assigned: avpaderno » Unassigned
Status: Needs work » Needs review
roberttabigue’s picture

roberttabigue commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new ckeditor_details_MR!8-before.png175.54 KB
new ckeditor_details_MR!8-after.png168.13 KB

Hi @avpaderno,

I have applied your latest MR!8 to the CKeditor Details Accordion module against 2.1.x-dev and confirmed that the help page has been updated.

Please see the attachments for reference.

I'm marking this now as "RTBC".

Thank you!

liam morland made their first commit to this issue’s fork.

liam morland’s picture

liam morland
Primary language English
Location Ontario, CA 🇨🇦
commented
Status: Reviewed & tested by the community » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.