Closed (fixed)
Project:
Drupal core
Version:
7.x-dev
Component:
documentation
Priority:
Minor
Category:
Bug report
Assigned:
Unassigned
Reporter:
Created:
9 Feb 2011 at 11:56 UTC
Updated:
5 Mar 2011 at 00:11 UTC
Jump to comment: Most recent file
Comments
Comment #1
Tor Arne Thune commentedComment #2
jhodgdonThanks... if you are going to fix that line, how about bringing that docblock into compliance with our doc standards, which it's nowhere close to complying with? I have a hard time marking doc patches as RTBC if the lines they are adding to the code have grammar problems, as is the case here.
Also, a code grep finds that there are also 6 places in includes/common.inc with that same problem, and two in modules/simpletest/tests/upgrade/drupal-6.filled.database.php. Maybe those could be fixed too?
I don't mind quick fixes, but when issues like this are brought up, I'm also in favor of making sure the problem is really eradicated, rather than just fixing one instance of the problem, if it's not too much trouble (like doing the same thing in 8 places rather than just one). If that were done, I might be inclined to overlook the lame docblock that is in the current patch....
Comment #3
Tor Arne Thune commentedChanged all occurrences of JavaScript (and some javascript where this was clearly not code) to JavaScript. Also changed AJAX to Ajax, as per the style guide. No code (or comment about a code) or user interface text has been touched, only comment documentation. I have also fixed some typos where I found them, around the Javascript and AJAX faults.
I also completed the sentence in menu.module.
Comment #4
jhodgdonReally, Ajax not AJAX? Hmmm. I guess you are right, Wikipedia writes it "Ajax" for instance, and you are correct that http://drupal.org/node/338208 says to use Ajax (the reasoning is that it used to stand for Asyncronous JavaScript And XML, but it often doesn't involve XML any more, so it's become a word rather than an acronym). Anyway, it does appear to be industry consensus as well as in our style guide. Thanks! Learn something every day...
The patch looks good to me. I did notice that AHAH is still all caps, but that is apparently correct. Let's get this cleanup in...
Comment #5
dries commentedCommitted to CVS HEAD. Thanks.