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.Here's a patch, as part of #537828: Help text for core modules - update to conform to new standard
This patch fixes up the main help screens for the system, syslog, and simpletest modules to conform with the new module help screen standards http://drupal.org/node/632280 (also some minor text changes).
| Comment | File | Size | Author |
|---|---|---|---|
| #20 | help_syslog-winfixup2.patch | 2.26 KB | arianek |
| #19 | syslog-winfixup.patch | 1.3 KB | jhodgdon |
| #12 | 634234new.patch | 15.73 KB | jhodgdon |
| #10 | help_simpletest_system_syslog_10.patch | 15.74 KB | lisarex |
| #3 | help_simpletest_system_syslog2.patch | 15.74 KB | arianek |
Comments
Comment #1
jhodgdontagging
Comment #3
arianek CreditAttribution: arianek commentedupdated these to follow the help/docs standards, fixed a bunch of code, attempted to update some of the language, but didn't heavily edit system or syslog, as i'm not too familiar with what's going on there technically.
updated some of the language in simpletest to read "simpletest" rather than "testing" but for instance, the page where you run simpletest is titled "Testing" so i left that. i *do* think we should update the name of the module in the help listing to simpletest though, since that *is* the name of the module (i'm not sure how to do this, or if we need consent from above).
Comment #6
tobiasbComment #7
jhodgdonIt is true that the machine-readable name of the module is "simpletest", but the human-readable name of the module is currently "Testing" (as displayed on the modules page). I imagine this must have been done consciously by the dev team... I strongly believe the name of the module displayed on the module page should agree with the name of the module as mentioned on the help screen. If you want to change both of them to "Simpletest", then you would need to edit/patch the .info file (that is where the human-readable name is defined), and I think you would need to get some input from the folks who maintain that module. Otherwise, please change the patch back to saying "Testing" for the name of the module in the help screens.
Comment #8
arianek CreditAttribution: arianek commentedI pinged the Simpletest people on this, chx is going to try and get a verdict and get back to me via IRC.
Comment #9
arianek CreditAttribution: arianek commentedi checked with chx, who checked with Dries, and they said to rename it all to testing module.
Comment #10
lisarex CreditAttribution: lisarex commentedReplaced Simpletest with Testing
Comment #11
arianek CreditAttribution: arianek commentedsetting as review for testbot
Comment #12
jhodgdonThere's still one place where it says SimpleTest (referring to the Simpletest API). Other than that I like it. Here's a revised patch. Leaving as Needs Review until the testing bot finishes, and then I think I'll just set it to RTBC.
As a note, we should also change the Handbook pages to say Testing instead of SimpleTest, though they actually need to say both (the module was called SimpleTest in Drupal 6, when it was a contrib module, before it was integrated into Drupal core). URLs referenced:
http://drupal.org/simpletest
http://drupal.org/handbook/modules/simpletest
I'll take care of this shortly.
Comment #13
jhodgdonIt turns out I didn't have sufficient permissions to take care of this, so I filed an issue:
#646808: SimpleTest contrib module in D6 -> Testing in D7 core
Comment #14
jhodgdonAs noted in #12, I think this one has now been reviewed sufficiently.
Comment #15
Dries CreditAttribution: Dries commentedCommitted to CVS HEAD. Thanks!
Comment #16
Dries CreditAttribution: Dries commentedCommitted to CVS HEAD. Thanks!
Comment #17
Xano- I am trying to get "The XX module" out of core, because people don't say "The Dries developer" or "The Volkswagen car" either. Modules have names; we should use them directly.
- Window's official name is Microsoft Windows.
Comment #18
jhodgdonXano: it is way too late for this type of change now in the help screens. The standard formatting for module help was agreed upon... see #537828: Help text for core modules - update to conform to new standard if you want to discuss it further. The deadline for changes to UI text is today, by the way.
Comment #19
jhodgdonRegarding your Windows comment, here's a patch to fix up syslog.
Again, if you want to discuss "the xyz module", please do it on the other issue.
Comment #20
arianek CreditAttribution: arianek commentedoops, that was my bad on the name change. caught an extraneous space in the already committed code while reviewing this, so here's a reroll fixing that as well. RTBCing.
Comment #21
Dries CreditAttribution: Dries commentedCommitted to CVS HEAD.