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.

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:

Comments

Sahana _N created an issue. See original summary.

sahana _n’s picture

Status: Active » Needs review
StatusFileSize
new1.07 KB

sahil.goyal made their first commit to this issue’s fork.

sahil.goyal’s picture

Status: Needs review » Reviewed & tested by the community
StatusFileSize
new59.94 KB

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

adamps’s picture

Status: Reviewed & tested by the community » Needs work

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.

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

urvashi_vora’s picture

Status: Needs work » Needs review

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

paraderojether’s picture

Status: Needs review » Reviewed & tested by the community
StatusFileSize
new49.83 KB
new57.12 KB
new154.27 KB

Hi @urvashi_vora

I reviewed the MR and the changes are verified, and it's working fine for me.

Moving this to RTBC.
Please look at the screenshot for reference. Thank You.

adamps’s picture

Status: Reviewed & tested by the community » Needs work

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
raveen_thakur51’s picture

StatusFileSize
new1.12 KB
new14.49 KB
new15.98 KB
new18.32 KB

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.

adamps’s picture

Status: Needs work » Needs review
elber’s picture

Status: Needs review » Reviewed & tested by the community

Hi moving to RTBC

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

raveen_thakur51’s picture

@elber, Thanks for confirmation.

astonvictor’s picture

Status: Reviewed & tested by the community » Needs work

astonvictor’s picture

Status: Needs work » Needs review

Created a new MR with hook_help().

adamps’s picture

Status: Needs review » Needs work

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?

raveen_thakur51’s picture

.

astonvictor’s picture

Status: Needs work » Needs review
adamps’s picture

Status: Needs review » Needs work

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 ".

adamps’s picture

Status: Needs work » Reviewed & tested by the community

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.

astonvictor’s picture

Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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