Hi guys.

We've implemented the help section for project.

Patch in attachment.

Regards.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

renatog created an issue. See original summary.

Pavan B S’s picture

Assigned: Unassigned » Pavan B S
Status: Needs review » Reviewed & tested by the community

Patch is working fine as per the uploaded image.

renatog’s picture

Hi @pavan-b-s.

Thank you very much for you review.

Good work and Good Weekend.

Regards.

lolandese’s picture

Assigned: Pavan B S » Unassigned
Status: Reviewed & tested by the community » Needs review
FileSize
505 bytes

Although there is nothing wrong with the provided patch, in practice most code defined help text tends to not be kept in sync with the README.txt.

Attached patch returns a line-break version of the README.txt used by hook_help() avoiding the cumbersome job of manual synchronization each time the README.txt changes.

Still a good suggestion to offer a help section considering a bunch of new features is going into the next stable release that would probably need explanation.

dhruveshdtripathi’s picture

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

Patch applied cleanly. Help text changed after last patch.

  • lolandese committed b4ccdbe on 7.x-2.x authored by renatog
    Issue #2855673 by renatog, lolandese, dhruveshdtripathi, Pavan B S:...
lolandese’s picture

Status: Reviewed & tested by the community » Fixed
renatog’s picture

Perfect @lolandese.

I agree with you.

That way we will have everything synchronized.
We can just update the README file and everything will be updated. Great!

Thank you very much!

Hugs.

  • lolandese committed b4ccdbe on 7.x-3.x authored by renatog
    Issue #2855673 by renatog, lolandese, dhruveshdtripathi, Pavan B S:...

Status: Fixed » Closed (fixed)

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

lolandese’s picture

Version: 7.x-2.x-dev » 8.x-2.x-dev
Status: Closed (fixed) » Patch (to be ported)
Parent issue: » #2189203: D8 port (from the existing 7.x-3.x to a new 8.x-3.x)

Note the D8 does not offer a help page yet. The same approach as above is proposed, thus using the README.txt (or .md). That needs to contain more information as it currently does.

The needed function still exists also in D8. See _filter_autop | filter.module | Drupal 8.8.x | Drupal API.