After enabling this module, we will have the README.txt, even though need to implement a hook_help for guideline for developer.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

madan879 created an issue. See original summary.

madan879’s picture

Assigned: madan879 » Unassigned
Status: Active » Needs review
FileSize
1.38 KB

I have created patch for hook_help()

drupalove’s picture

Hi Madan,

lines of code should not be longer than 80 characters. See the Coding standards documentation.

However, it is better to use the markdown filter with the existing readme file to avoid adding a big chunk of text. I prefer this option, what do you think?

Alternatively, return the output with the advanced_help_hint_docs() function since the module already has online documentation. See Advance help hint. You can still add a fallback description in case the function doesn't exist, see the example under Provide help text in Drupal UI section in the Module documentation guidelines.

Changing the status of this issue to needs work.

drupalove’s picture

Status: Needs review » Needs work
madan879’s picture

Status: Needs work » Needs review

Thanks @drupalove for reviewed patch...

Before creating a patch for hook_help(), I have gone through the core modules like search.module file for how they have handled long description in hook_help(). They aren't limited upto 80 characters, because the user/developer need to read long description about module, this is my assumption.

Generally, limiting characters are seen in comments lines, form attributes like description, title...

And its not a application blocker, so it wont through any errors too..

If you are feel above mentioned points are valid, please kindly change status to RTBC...

And feel free to suggest anything....I will accept it..

stefan.r’s picture

Status: Needs review » Reviewed & tested by the community

stefan.r’s picture

Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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