Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Munavijayalakshmi created an issue. See original summary.

Munavijayalakshmi’s picture

Assigned: Munavijayalakshmi » Unassigned
Status: Active » Needs review
FileSize
832 bytes
dhruveshdtripathi’s picture

Status: Needs review » Needs work

Follow Help Text standards https://www.drupal.org/docs/develop/documenting-your-project/help-text-standards

Uses section is not there.

dhruveshdtripathi’s picture

Assigned: Unassigned » dhruveshdtripathi
Status: Needs work » Needs review

Working on it.

dhruveshdtripathi’s picture

Status: Needs review » Needs work
dhruveshdtripathi’s picture

Assigned: dhruveshdtripathi » Unassigned
Status: Needs work » Needs review
FileSize
1.46 KB
1.22 KB

Made changes according to standards. Interdiff added.

Aanal.addweb’s picture

Status: Needs review » Reviewed & tested by the community
FileSize
7.27 KB
7.52 KB

@dhruveshdtripathi, Thanks for patch, it works well i checked it with simplytest.me. PFA

guschilds’s picture

Status: Reviewed & tested by the community » Needs work

Thanks for the patch. A couple things:

  • While there really shouldn't be a require_once() call at the top of the module like there is, that call should stay at the top. The added youtube_help() should at least come after that call and before youtube_menu().
  • If we're going to add this, it should be added to Drupal 8 as well. Please port the patch so both could be committed at the same time.

Thanks again!

dhruveshdtripathi’s picture

Assigned: Unassigned » dhruveshdtripathi

Agreed! Working on that.

dhruveshdtripathi’s picture

Assigned: dhruveshdtripathi » Unassigned
Status: Needs work » Needs review
FileSize
1.52 KB
470 bytes

Moved hook_help section between require_once and hook_menu. About Drupal8. I'll be working on it after D7 gets committed. We'll move this issue to D8 after it gets committed to D7. Suggested me any other changes if needed.

Thanks!

dhruveshdtripathi’s picture

Gold’s picture

Status: Needs review » Needs work

Looking good. Just a few Drupal code standards to sort out and this looks done.

  1. +++ b/youtube.module
    @@ -4,9 +4,32 @@
    + * Implementation of hook_help().
    

    Format should be "* Implements hook_foo().", "* Implements hook_foo_BAR_ID_bar() for xyz_bar().", "* Implements hook_foo_BAR_ID_bar() for xyz-bar.html.twig.", "* Implements hook_foo_BAR_ID_bar() for xyz-bar.tpl.php.", or "* Implements hook_foo_BAR_ID_bar() for block templates."

  2. +++ b/youtube.module
    @@ -4,9 +4,32 @@
    +      $output .= '<p>' . t('For more information, see the <a href="https://www.drupal.org/project/youtube">Youtube Field module</a>.' . '</p>');
    

    The closing paragraph tag should not be in the t().

  3. +++ b/youtube.module
    @@ -4,9 +4,32 @@
    +      $output .= '<h5>' . t('The module provides following Display Types: ') . '</h5>';
    

    Translatable strings should not start or end with white space.

harsha012’s picture

Status: Needs work » Needs review
FileSize
1.52 KB
1.29 KB
Gold’s picture

Status: Needs review » Needs work
+++ b/youtube.module
@@ -4,9 +4,32 @@
+ * Implements of hook_help().

Almost there.

Lose the "of" and it's done.

Gold’s picture

Just a note on Code Standards; The Coder module is very handy in checking these. It works from the website and can integrate into external tools like PHP CodeSniffer which, in turn, can integrate into your preferred code editor.

I find it very handy for this sort of thing.

This comment also tweaks the commit details a bit. I just read Commit messages - providing history and credit and noticed that the automated details get a little lost after multiple people start tweaking the patch.

harsha012’s picture

Status: Needs work » Needs review
FileSize
1.52 KB

Fixed the minor nit pick

Aanal.addweb’s picture

Status: Needs review » Reviewed & tested by the community

@harsha012, Thanks for Providing patch, Now all the errors are clear & your patch works correctly for me.

Gold’s picture

Indeed, it is a minor nit pick. But they're called Standards for a reason. Automated tools can't really sit there and go "meh, not a big deal".

This looks good to me now too. +1 for RTBC.

@harsha012 thanks for your time on this. :)

imyaro’s picture

Assigned: Unassigned » imyaro

imyaro’s picture

Status: Reviewed & tested by the community » Fixed

Changed a little and commited.

Status: Fixed » Closed (fixed)

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