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.
Final of the series (sorry it was so prolific- I should have done all the modules as one patch). This includes all the minimal changes needed for the stuff I haven't already done.
Comment | File | Size | Author |
---|---|---|---|
#19 | general_commentstandardsV5.patch | 16.07 KB | aspilicious |
#15 | general_commentstandardsV4.patch | 16.07 KB | aspilicious |
#10 | general_commentstandardsv3.patch | 16.2 KB | aspilicious |
#3 | general_commentstandardsv2.patch | 11.28 KB | aspilicious |
general_commentstandards.patch | 10.5 KB | birdmanx35 | |
Comments
Comment #1
catchIgen.
Comment #2
catchNo longer applies.
Comment #3
aspilicious CreditAttribution: aspilicious commentedLet me help cleanup some old issues...
Comment #4
aspilicious CreditAttribution: aspilicious commentedComment #5
aspilicious CreditAttribution: aspilicious commentedComment #6
jhodgdonMostly OK.
A few things:
- Doc headers for functions need to start with 3rd person verb, like:
Should be "Returns".
Also verify -> verifies in the next one.
Also, this one needs a one-line description at the beginning:
Comment #7
aspilicious CreditAttribution: aspilicious commentedsomething like this?
Comment #8
jhodgdonYeah, something like that would be good.... How about:
Comment #9
aspilicious CreditAttribution: aspilicious commentedNice like it, my english skills aren't good enough to write such a text, luckily we have jhodgdon...
I'll fix those asap
Comment #10
aspilicious CreditAttribution: aspilicious commentedI have the feeling that this one is getting big again...
Comment #11
aspilicious CreditAttribution: aspilicious commentedComment #13
aspilicious CreditAttribution: aspilicious commented#10: general_commentstandardsv3.patch queued for re-testing.
Comment #14
jhodgdonCurrent patch:
a)
Verify -> Verifies... Actually, what does this function do? Probably should say "Verifies the existence of settings.php.", if that is what the function does? The current doc header doesn't make any sense to me.
b)
return -> returns
This also happens later in the file:
report -> reports
c)
Good try, but I don't think "Batch callback" is a verb. :) I would just leave this as "Batch callback" for now at least.
d)
I didn't mean the ... or function_foo() function_bar() etc. literally! Either remove that sentence or track down where that flag is checked for. :)
Comment #15
aspilicious CreditAttribution: aspilicious commentedd) I thought it was a coding standard for telling a lot of places.
In general: my english sucks
Comment #16
aspilicious CreditAttribution: aspilicious commentedComment #17
jhodgdonAlmost! There is still one more English grammar spot. Fix this and it's RTBC as far as I am concerned:
end -> ends
Comment #18
jhodgdonComment #19
aspilicious CreditAttribution: aspilicious commentedRTBC version :)
Comment #20
aspilicious CreditAttribution: aspilicious commentedComment #21
jhodgdonThanks!
Comment #22
Dries CreditAttribution: Dries commentedCommitted to CVS HEAD. Thanks.