Properly comment Table Wizard; run coder and cleanup formatting.

CommentFileSizeAuthor
#2 392302_code_cleanup.patch25.47 KBalex_b

Comments

alex_b’s picture

alex_b commented
Version: » 6.x-1.x-dev
Priority: Minor » Normal

Here you go...

* Cleans up coder module notices.
* Removes _ prefix from form callbacks (not usual in Drupal, Form API does not expect these and generates funny -id-my-form CSS ids from it). -> clear cache after applying patch!
* Clean up comments: remove IDE comment template cruft ('unknown', 'Enter description here', ...) and comment where this cleanup leaves functions without comments (very few).

One comment I'm not sure about is 

/**
 * Implementation of hook_tw_form_submit_<type>.
 */
function tw_tw_form_submit_existing($values) {

I'm bumping this to normal as it would be great to commit a cleanup soon. Some patches will be affected in a minor way, so the sooner we get this out of the way, the better.

alex_b’s picture

alex_b commented
StatusFileSize
new 392302_code_cleanup.patch25.47 KB
webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented
Status: Active » Needs review
mikeryan’s picture

mikeryan
he/him
Primary language English
Location Pittsfield, MA, USA
commented

Most changes applied, I needed to manually apply the tw_import_delimited stuff. However, the string concats are funky - no spaces between the . and either single or double quotes, I'll fix those up and commit...

mikeryan’s picture

mikeryan
he/him
Primary language English
Location Pittsfield, MA, USA
commented

OK, I see coder complaining about "string concatenation should be formatted without a space separating the operators (dot .) and a quote". But, the coding standards clearly say there should be spaces on both sides (which certainly looks cleaner and more consistent to me). What's up with that?

Ahhh, this is up with that: #246568: Coding standards of string concatenation have changed... I'm going with a space on each side.

mikeryan’s picture

mikeryan
he/him
Primary language English
Location Pittsfield, MA, USA
commented
Status: Needs review » Needs work

Committed - I still want to go through and make sure I've got enough comments and they're accurate.

mikeryan’s picture

mikeryan
he/him
Primary language English
Location Pittsfield, MA, USA
commented
Status: Needs work » Fixed

Good enough for now, I think...

Status: Fixed » Closed (fixed)

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