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.Background:
This issue is part of the meta-issue for updating 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 http://drupal.org/node/632280
More details are on the meta-issue.
| Comment | File | Size | Author |
|---|---|---|---|
| #11 | update-hook-help-simpletest-2103041-11.patch | 3.66 KB | batigolix |
| #11 | interdiff.txt | 2.36 KB | batigolix |
| #9 | interdiff.txt | 1.92 KB | batigolix |
| #9 | update-hook-help-simpletest-2103041-9.patch | 3.04 KB | batigolix |
| #7 | update-hook-help-simpletest-2103041-7.patch | 3.22 KB | batigolix |
Comments
Comment #1
batigolixpatch:
- changes link tokens according to guidelines
- changes http > https
- remove unused link token
I couldtn find any UI change records for this module so I assume there is no reason to change anything else: https://drupal.org/list-changes?keywords_description=syslog&to_branch=&v...
Comment #2
batigolixchange status
Comment #3
batigolixchanging component so that maintainers can have a say
Comment #4
jhodgdonThe search in #1 appears to be for syslog module not simpletest. And I'm pretty sure we mostly use change records for API changes; not so much for UI changes.
That said... This patch also needs to change the format/text of how we link to the online docs to conform with our current standards (last sentence in About).
Other than that, I don't think probably anything else needs to be changed or updated. Thanks!
Comment #5
batigolixThis patch:
- adds the standard reference to the online docs
- removes the reference to "the Drupal handbook"
I wonder if we should mention the word "Simpletest" here, since the whole world knows this core module as such (and the online docs call it "Simpletest"), maybe something like
This might prevent a little bit of confusion
Comment #6
jhodgdonLooking good, thanks! One comment and one small thing to fix:
- I don't think we want to use the word "simpletest". There was a lot of discussion about the name change to "Testing" (it wasn't an arbitrary change), and it was called "Testing" in Drupal 7 as well. So let's leave that as it is.
- I noticed one more thing: we need to take out the word "unit" in the "automated unit tests" line. Unit tests are a very specific subset of what the Testing module runs -- it does unit tests and functional tests both, so let's just say it does automated tests rather than inaccurately calling them all unit tests.
This will also need manual testing:
- Verify the formatting is fine
- Verify all the links go to the right place
- Verify that when it is describing the user interface, the directions make sense and match what you see.
Comment #7
batigolixRemoved "unit" from "unit tests".
Still remains to be done (see #6):
Comment #8
jhodgdonHm. One other thing I noticed in reviewing the existing hook_help for this module. There is a sentence at the end of the "Running tests" Uses section that tells about how to create and modify your own tests. That seems like it belongs in About instead, or in a separate Uses section? It isn't about running tests.
Comment #9
batigolixI think that line can go. It adds very little information and it links to a page that is also linked to from the Module's online docs page.
This patch removes that line.
Comment #10
jhodgdonAgreed, that line can go. You left an extra space before the ' when you removed it though. Nitpick! Everything else looks great here.
Still needs a manual review for formatting and making sure the links work.
Comment #11
batigolix- removed the white space
- fixed formatting problem in the uses section. changed if from:
to:
Someone else should still review the patch . see #10
Comment #12
jhodgdonLooks good to me!
I think all that's missing is a manual review:
- Verify that all the links work
- Verify that all mentions of pages/text within the UI match what is seen in the UI
- Verify that the formatting is OK.
Comment #13
batigolixComment #14
jhodgdonI gave this a manual test today and it is all fine.
Comment #15
jhodgdonThere's an "avoid commit conflicts" issue touching simpletest.module, so I'm going to be extra-careful and wait to commit this until it's taken care of:
#1996238: Replace hook_library_info() by *.libraries.yml file
Comment #16
jhodgdonI got leave from the other issue people to commit this. So, committed to 8.x. Thanks again!