Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.Follow-up to #2349565: Review/update block_content hook_help text & child issue of #2283477: [META] Review hook_help texts & copy text to drupal.org
The block hook_help text needs to be reviewed, because it was written long time ago and Drupal 8 has changed quite a bit.
| Comment | File | Size | Author |
|---|---|---|---|
| #10 | error.png | 110.81 KB | manauwarsheikh |
| #6 | 2349907-block-help-6.patch | 4.83 KB | jhodgdon |
Comments
Comment #1
batigolixComment #2
susanb CreditAttribution: susanb commentedSimplified language to make block help text clearer.
Comment #3
jhodgdonThanks for the patch!
This patch has some problems:
- "it can also placed" ==> needs "be" in there [this is in the About section)
- I don't think I agree with the last change in the patch. It changed wording about toggling the block title display to saying 'display it' but I think the "it" is unclear. I prefer the previous wording of this paragraph. (Configuring Blocks section).
Also changing the title and parent of this issue, since it's now about fixing the help text.
Comment #4
jhodgdonThere's a "the the" in the About section of this help text that also needs to be replaced with "the".
Comment #5
jhodgdonInstead of having one critical parent issue I have been asked to change the status of each child issue.
This one doesn't seem to major to me. But yes we should get it done.
Comment #6
jhodgdonThis patch no longer applies. :(
So... I read through the patch again, and applied most of it (see #3). Also read through the Block help and rewrote quite a bit of it -- we don't want or need to explain the details of how to use user interfaces, we just want to give people background information and point them to the hopefully clear UI. I thought that changing the order of the Uses would eliminate some duplicate information, so I did that as well.
One other thing. The Block Content help link has to be wrapped in a check to verify that the module actually is installed. And we shouldn't have to tell people how to install a module in this help.
With all of that in mind, here's a new patch.
Comment #10
manauwarsheikh CreditAttribution: manauwarsheikh commentedIt's throwing error in Simplytest.me (attached screenshot error.png).
Comment #11
manauwarsheikh CreditAttribution: manauwarsheikh commentedComment #12
j2r CreditAttribution: j2r commented#6 patch is working fine. tested.
@manauwarsheikh : The patch is not applied on drupal core so you wont be able to check it on simplytest.me. Clone the D8 on your local and test.
Comment #13
j2r CreditAttribution: j2r commentedComment #14
jhodgdonThe help text in the patch still needs a review, which would be greatly appreciated!
The timezone warning on simplytest.me is NOT due to this patch.
Comment #16
ifrikAll links work and are named correctly.
The About and Use section cover all relevant issues, and are written clearly.
Comment #17
alexpottDocs changes are not restricted during beta. Committed 8ad9387 and pushed to 8.0.x. Thanks!
Comment #19
ifrik