Problem/Motivation

The example for the hook_help text does not explain how the help texts, and especially the content of the help page should look like.

Proposed resolution

Add a link to the Help text standard documentation at https://www.drupal.org/documentation/help-text-standards

Remaining tasks

User interface changes

API changes

Data model changes

CommentFileSizeAuthor
#6 link-help-text-documentation-2650926-6.patch655 bytesdevaraj johnson
#2 2650926-help-text-standard-link-2.patch641 bytesifrik

Comments

ifrik created an issue. See original summary.

ifrik’s picture

ifrik
she/her
commented
Status: Active » Needs review
StatusFileSize
new 2650926-help-text-standard-link-2.patch641 bytes

I've added a link to https://www.drupal.org/documentation/help-text-standards

chx’s picture

chx commented
Category: Feature request » Task
Status: Needs review » Reviewed & tested by the community

Looks great.

ifrik’s picture

ifrik
she/her
commented
Assigned: ifrik » Unassigned
mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented
Status: Reviewed & tested by the community » Needs work 
+++ b/page_example/page_example.module
@@ -36,6 +36,9 @@ use Drupal\Core\Routing\RouteMatchInterface;
+ * See the Help text standard page for the proposed format of help texts:
+ * https://www.drupal.org/documentation/help-text-standards
+ *
  * @see hook_help()

Nice. That'd be great to add. But it needs to be a @see annotation, since that's how our coding standards work: https://www.drupal.org/coding-standards/docs#see

devaraj johnson’s picture

devaraj johnson commented
StatusFileSize
new link-help-text-documentation-2650926-6.patch655 bytes

I have modified the changes and uploaded the patch

devaraj johnson’s picture

devaraj johnson commented
Status: Needs work » Needs review
jerryimiolo’s picture

jerryimiolo commented
Status: Needs review » Reviewed & tested by the community
Issue tags: +Seattle Global Sprint

Verified that the @see is there and that it is correct.

mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented
Status: Reviewed & tested by the community » Fixed

Still has a whitespace error, fixed on commit.

Fixed! Thanks, folks.

  • Mile23 committed ca0e665 on 8.x-1.x authored by Devaraj johnson 
    Issue #2650926 by ifrik, Devaraj johnson, jerryimiolo: Link to the Help...

Status: Fixed » Closed (fixed)

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