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.

Files: 
CommentFileSizeAuthor
#11 update-hook-help-simpletest-2103041-11.patch3.66 KBbatigolix
PASSED: [[SimpleTest]]: [MySQL] 59,750 pass(es).
[ View ]
#11 interdiff.txt2.36 KBbatigolix
#9 interdiff.txt1.92 KBbatigolix
#9 update-hook-help-simpletest-2103041-9.patch3.04 KBbatigolix
PASSED: [[SimpleTest]]: [MySQL] 59,750 pass(es).
[ View ]
#7 update-hook-help-simpletest-2103041-7.patch3.22 KBbatigolix
PASSED: [[SimpleTest]]: [MySQL] 60,110 pass(es).
[ View ]
#7 interdiff.txt1.32 KBbatigolix
#5 interdiff.txt3.11 KBbatigolix
#5 update-hook-help-simpletest-2103041-5.patch3.22 KBbatigolix
PASSED: [[SimpleTest]]: [MySQL] 59,284 pass(es).
[ View ]
#1 update-hook-help-simpletest-2103041-1.patch3.24 KBbatigolix
PASSED: [[SimpleTest]]: [MySQL] 58,981 pass(es).
[ View ]

Comments

batigolix’s picture

StatusFileSize
new3.24 KB
PASSED: [[SimpleTest]]: [MySQL] 58,981 pass(es).
[ View ]

patch:

- 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...

batigolix’s picture

Status:Active» Needs review

change status

batigolix’s picture

Component:documentation» simpletest.module

changing component so that maintainers can have a say

jhodgdon’s picture

Status:Needs review» Needs work

The 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!

batigolix’s picture

Issue summary:View changes
Status:Needs work» Needs review
StatusFileSize
new3.22 KB
PASSED: [[SimpleTest]]: [MySQL] 59,284 pass(es).
[ View ]
new3.11 KB

This 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

The Testing module (also referred to as "SimpleTest") provides a framework for running automated unit tests.

This might prevent a little bit of confusion

jhodgdon’s picture

Status:Needs review» Needs work
Issue tags:+Needs manual testing

Looking 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.

batigolix’s picture

Status:Needs work» Needs review
Parent issue:» #1908570: [meta] Update or create hook_help() texts for D8 core modules
StatusFileSize
new1.32 KB
new3.22 KB
PASSED: [[SimpleTest]]: [MySQL] 60,110 pass(es).
[ View ]

Removed "unit" from "unit tests".

Still remains to be done (see #6):

- 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.
jhodgdon’s picture

Status:Needs review» Needs work

Hm. 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.

batigolix’s picture

Status:Needs work» Needs review
StatusFileSize
new3.04 KB
PASSED: [[SimpleTest]]: [MySQL] 59,750 pass(es).
[ View ]
new1.92 KB

I 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.

jhodgdon’s picture

Status:Needs review» Needs work

Agreed, 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.

batigolix’s picture

Status:Needs work» Needs review
StatusFileSize
new2.36 KB
new3.66 KB
PASSED: [[SimpleTest]]: [MySQL] 59,750 pass(es).
[ View ]

- removed the white space
- fixed formatting problem in the uses section. changed if from:

dl
dt
  dd
  dd

to:

dl
dt
dd
  p
  p

Someone else should still review the patch . see #10

jhodgdon’s picture

Looks 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.

batigolix’s picture

Issue tags:+Novice
jhodgdon’s picture

Component:simpletest.module» documentation
Status:Needs review» Reviewed & tested by the community

I gave this a manual test today and it is all fine.

jhodgdon’s picture

There'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

jhodgdon’s picture

Status:Reviewed & tested by the community» Fixed
Issue tags:-Needs manual testing

I got leave from the other issue people to commit this. So, committed to 8.x. Thanks again!

Status:Fixed» Closed (fixed)

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