The enclosed patch includes codestyle improvements for all children modules of Panels.
Inspired by the coder module, these mostly concern the documentation standards (such as missing periods or a missing @file block).
However, I did not change the string concatenation format as this standard has changed anyway and we don't want to change it forth and back.
Also I consistently split out '
' and '
' from t()-calls, where this was not yet done.
In panels_view.module the comments inconsistently referred to either 'panel view' or 'view pane'. I consistently changed this to the latter as we anyway want to move there. Accordingly I changed some occurrences of 'panel mini' to 'mini panel'.
Comment | File | Size | Author |
---|---|---|---|
#8 | panels-DRUPAL-5--2-cleanup.patch | 219.11 KB | sun |
#6 | panels-DRUPAL-5--2.code-coder-cleanup.patch | 219.11 KB | sun |
#4 | panels-DRUPAL-5--2.code-cleanup.patch | 35.78 KB | sun |
#3 | panels_codestyle_3.patch | 32.06 KB | Pancho |
panels_codestyle.patch | 32.79 KB | Pancho | |
Comments
Comment #1
PanchoOops, should have commented that out... I meant < p > and < /p >.
Comment #2
sdboyer CreditAttribution: sdboyer commentedGreat...but...could you reroll the patch? Sorry, too many commits...
Comment #3
PanchoSure, here we go...
Btw: Rerolled this patch from within the panels project. Usually, patches made from a too high level are no problem, with the Eclipse option "Ignore leading path name segments", but if this is better, I'll always try to do it this way...
Comment #4
sunFixed switch statements and string concatenations in implementations of hook_help().
Other than that, looks good!
Comment #5
PanchoOoops, thanks for fixing this... :)
Comment #6
sunAdvanced code clean-up using coder_format, and extensive review of all fixes.
I will probably have no time to re-roll this patch, so either commit it now, or leave it ugly.
@sdboyer: I think you want to apply the patch this time... ;) (missing fixes in panels_views.install are included)
Comment #7
sdboyer CreditAttribution: sdboyer commenteddear.freakin.god.lol.
Yeah, applying the patch will definitely be preferable here. I didn't even notice the spacing issue when I manually rewrote panels_views.install...was too embarrassed about all the little bugs in beta4 to pay close attention, I think :)
Comment #8
sunPlease note that patch in #6 probably breaks all existing patches in the queue. However, having a consistent coding-style that adheres to Drupal's Coding Standards is the key for fast and community-driven development.
Re-rolled, since #262956: Fatal error for mini panels layout settings has been committed.
Comment #9
sdboyer CreditAttribution: sdboyer commentedOK, with very few exceptions, this patch has been APPLIED ;) and committed.
I totally didn't know that putting single-line comments alone on the line before the code they refer to is a drupal coding standard...
Comment #10
sdboyer CreditAttribution: sdboyer commentedNote - I worked from the one in #6, no worries; I accounted for the differences as needed.
Comment #11
sunRe: #9 inline comments: There is no coding standard for them yet. It depends on the context whether they are clean. I thought I left most inline comments as they were, but there were some cases where a full sentence followed an already long line of code. See related discussion.
Comment #12
Anonymous (not verified) CreditAttribution: Anonymous commentedAutomatically closed -- issue fixed for two weeks with no activity.