Problem/Motivation

The module does not implement hook_help(), which helps users understand the module and is a recommendation in pareview.sh.

Proposed resolution

Implement hook_help() by reading the contents of README.md, thereby avoiding duplication of the same information in multiple locations.

Remaining tasks

Implement.

User interface changes

Help information will be available.

API changes

None.

Data model changes

None.

CommentFileSizeAuthor
#5 Screen Shot 2019-06-26 at 5.51.14 PM.png191.17 KBalonaoneill
#2 fragments-3037141-2.patch2.99 KBkrina.addweb

Comments

eelkeblok created an issue. See original summary.

krina.addweb’s picture

krina.addweb commented
StatusFileSize
new fragments-3037141-2.patch2.99 KB

@eelkeblok, Please find my attached patch on the basis of the above-mentioned requirement. Kindly Review it & let me know your views on the same.
thanks!..

krina.addweb’s picture

krina.addweb commented
Status: Active » Needs review
alonaoneill’s picture

alonaoneill commented
Status: Needs review » Needs work 
+++ b/fragments.module
@@ -30,3 +32,44 @@ function fragments_theme_suggestions_fragment(array $variables) {
\ No newline at end of file

Needs line at the end.

alonaoneill’s picture

alonaoneill commented
StatusFileSize
new Screen Shot 2019-06-26 at 5.51.14 PM.png191.17 KB

Also links doesn't work properly and maybe it's better to put as a list?
Maybe someone else has some thoughts.

eelkeblok’s picture

eelkeblok
he/him
Primary language Dutch
Location Netherlands 🇳🇱
commented

It doesn't look like the patch actually does what the summary says; it contains the readme information as hardcoded HTML.

eelkeblok’s picture

eelkeblok
he/him
Primary language Dutch
Location Netherlands 🇳🇱
commented
Status: Needs work » Fixed

I implemented hook_help as suggested at https://www.drupal.org/docs/develop/documenting-your-project/module-docu..., by reading the README.md (which I just updated). Thanks for your work on this.

  • eelkeblok committed a95bfba on 8.x-1.x 
    Issue #3037141 by krina.addweb, alonaoneill, eelkeblok: Implement...

Status: Fixed » Closed (fixed)

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