Per the Module documentation guidelines, a module should Provide help text in the Drupal UI. This module is missing an implementation of hook_help(), but it does provide a fairly comprehensive README file, which can be included in hook_help() as a stop gap until something better can be created.

Documentation:
https://www.drupal.org/docs/develop/documenting-your-project/module-docu...
https://www.drupal.org/node/632280
Patch to follow, thanks!

Comments

alonaoneill created an issue. See original summary.

alonaoneill’s picture

Assigned: alonaoneill » Unassigned
Status: Active » Needs review
StatusFileSize
new1.71 KB

I uploaded the patch that adds hook_help file.
Thanks

avpaderno’s picture

Version: 8.x-1.2 » 8.x-1.x-dev
alonaoneill’s picture

StatusFileSize
new1.08 KB

I uploaded new patch that adds different hook_help.
Can you check please?
Thanks

krina.addweb’s picture

Status: Needs review » Needs work
StatusFileSize
new51.39 KB

@alonaoneill, Thanks for the patch, I reviewed it using coding standards & attached my suggested changes in attached s.s could you please review it & share your valuable feedback for the same.

alonaoneill’s picture

Status: Needs work » Needs review
StatusFileSize
new1.37 KB
new1.42 KB

I uploaded the patch that removes Usage part, as it's not helpfull since it gives you configuration info, that was already done at that point.

alonaoneill’s picture

Added wrong one by mistake.

Willtg’s picture

Status: Needs review » Needs work
diff --git a/request_info.info.yml b/request_info.info.yml
index c85f98e..f00006c 100644
--- a/request_info.info.yml
+++ b/request_info.info.yml
@@ -1,4 +1,4 @@
-name: Request info
+name: Request Info
 type: module
 description: Displays request information at the status report.
 package: Utility

It looks like the info file changes were added to this patch that need to be removed.

alonaoneill’s picture

Status: Needs work » Needs review
StatusFileSize
new1.13 KB

Made changes!

Willtg’s picture

StatusFileSize
new54.73 KB

.

Willtg’s picture

Status: Needs review » Reviewed & tested by the community
StatusFileSize
new54.73 KB

Patch tested with STM and it worked fine. Adding a screenshot below for confirmation.
Code looks good marking RTBC!

fago’s picture

Status: Reviewed & tested by the community » Needs work

+ * @file
+ * Primary module hooks for Podigee Podcast Player module.
+ */

this does not look right.

avpaderno’s picture

+      $output .= '<p>' . t('This is a tiny helper to add request information to Drupals status report. This is helpful to verify that Drupal is configured correctly; e.g., trusted reverse proxy addresses are configured correctly and HTTP headers are followed.') . '</p>';
+
+            // Add a link to the Drupal.org project.

There is a spelling error in the help message; the punctuation needs to be changed too. A better message would be similar to the following one.

This is a tiny helper to add request information to the status report. This is helpful to verify that Drupal is correctly configured, for example trusted reverse proxy addresses are configured or HTTP headers are followed.

I cannot say whether HTTP headers are followed is correct, as I cannot understand what the phrase means in this context. I would use a more explicit phrase.

The Add a link to the Drupal.org project. comment describes what is already clear in the code. Code comments should be used to describe something about the code that reading the code doesn't make clear.

+      $output .= t('Visit the <a href=":project_link">Request info project pages</a> on Drupal.org for more information.',[
+        ':project_link' => 'https://www.drupal.org/project/request_info'
+        ]);

The project page is only one. The message should read as Visit the Request info project page for more information.

avpaderno’s picture

Title: Hook Help is missing » Add hook_help()
Status: Needs work » Needs review
StatusFileSize
new1.04 KB

I also moved the use line, which should come after the @file comment, and referred to the project as Request Info, which is the module name since the patch in #3025863: Capitalize the name of the module in .info.yml file has been committed.

  • golubovicm committed ae14429 on 8.x-1.x authored by apaderno
    Issue #3062638 by alonaoneill, apaderno, Willtg, krina.addweb, fago: Add...
golubovicm’s picture

Status: Needs review » Fixed

Thank you for contributing to this module.
This improvement will be available in the next official release.

Status: Fixed » Closed (fixed)

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