Background:
This issue is part of the task to update the hook_help texts of the Drupal 8 modules:
#1908570: [meta] Update or create hook_help() texts for D8 core modules

Tasks:
- review / write the hook_help text according to help guidelines

CommentFileSizeAuthor
#5 syslog-help-text-2091425-5.patch2.12 KBifrik
#5 interdiff-2091425-4-5.txt2.12 KBifrik
#4 syslog-help-text-2091425-4.patch2.08 KBbatigolix
#2 syslog-help-text-2091425-1.patch2.08 KBwzoom

Comments

wzoom’s picture

wzoom commented
Assigned: Unassigned » wzoom

I am working on the documentation.

wzoom’s picture

wzoom commented
Assigned: wzoom » Unassigned
Status: Active » Needs review
StatusFileSize
new syslog-help-text-2091425-1.patch2.08 KB
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Needs work

Thanks for the patch, and sorry for the delay in reviewing this patch -- the help sprint was so successful, I have been having trouble catching up!

The change from double to single quotes here is not wanted. Our coding standards say that if there are apostrophes in text, you should enclose it in double quotes. So can you put that back?

Other than that, looks good!

batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented
Status: Needs work » Needs review
StatusFileSize
new syslog-help-text-2091425-4.patch2.08 KB

patch reverts quotes and changes http to https in link to d.o.

ifrik’s picture

ifrik
she/her
commented
StatusFileSize
new interdiff-2091425-4-5.txt2.12 KB
new syslog-help-text-2091425-5.patch2.12 KB

I've changed the sentence "For more info..." in the about section according to the Help text standard, and made the reference to the php documentation pages a bit clearer.

batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented
Component: documentation » simpletest.module

changing component for maintainers feedback, if any

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Component: simpletest.module » syslog.module
Status: Needs review » Reviewed & tested by the community

Slip of the finger - here's the right component. :)

Actually though, since we are not changing the help text for this module, I don't even know if we need a review by the maintainers. However, it can't hurt.

These changes seem to be fine and I'll tentatively set this to RTBC.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Component: syslog.module » documentation
Status: Reviewed & tested by the community » Fixed

I decided to just go ahead and commit this, since it is just a standards update. Thanks all!

Status: Fixed » Closed (fixed)

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