Closed (fixed)
Project:
Drupal core
Version:
8.0.x-dev
Component:
documentation
Priority:
Normal
Category:
Task
Assigned:
Reporter:
Created:
16 Mar 2012 at 20:52 UTC
Updated:
29 Jul 2014 at 20:29 UTC
Jump to comment: Most recent file
patch attached.
| Comment | File | Size | Author |
|---|---|---|---|
| #5 | function-header-coding-standards-1485966-5.patch | 476 bytes | vegantriathlete |
| #2 | function-header-coding-standards-1485966-2.patch | 451 bytes | vegantriathlete |
| #1 | function-header-coding-standars-1485966-1].patch | 451 bytes | vegantriathlete |
Comments
Comment #1
vegantriathleteAnd here it is!
Comment #2
vegantriathleteLet's try that again with the patch named without typos.
Comment #3
vegantriathleteAnd how about remembering to set the status?
Comment #4
vegantriathleteI've got the patch rolled for 8.x as well, but I know NOT to include it yet or I will hose things.
Comment #5
vegantriathlete#2 is for D7. Attached patch is for D8.
Comment #6
rafamd commentedComment #7
rafamd commentedooops .. restoring component
Comment #8
kid_icarus commented#5 applies cleanly at 89f2654
This looks good!
However, can you please include parameter comments for $path and $arg, as well as the return comment?
Please reference http://drupal.org/node/1354/#functions under Parameters and also Return Value
Comment #9
rafamd commentedWell, this kind of functions (hooks) have a slightly different documentation standard (found on a different section of the same page you linked), see: http://drupal.org/node/1354/#hookimpl
To cite the first pragraph: "If the implementation of a hook is rather standard and does not require more explanation than the hook reference provides, a shorthand documentation form may be used in place of the full function documentation block described above:"
Given that this seems to be a standard implementation of the hook and that the patch applies cleanly, RTBC, IMHO (revert if you disagree).
Comment #10
vegantriathleteThis is a change to image.module not documentation.
Comment #11
kid_icarus commented@rafamd You are correct. I stand corrected: no @param or @return for a hook implementation. :) Thanks @vegantriathlete!
Second on the rtbc, unless there is a pending larger documentation patch dealing with the entire image module.
Which there is :-( #1326608: Clean up API docs for image module
Thoughts?
Comment #12
rafamd commentedouch! :)
I'd say close this issue and enhance that other one (will facilitate commiter's job).
checked and this change isn't included in the proposed patch.
Comment #13
vegantriathleteDon't forget that I also included a patch for D7. How about getting RTBC for the D7 patch so that can be rolled before the backport to D7 for the above issue?
Comment #14
rafamd commentedThis is only my opinion and is that joint efforts are good, making everyones life easier. Just imagine if we had one issue with 15 comments for every little change in that other issue (strange example to make my point). Of course everyone's work on little issues like this one is *very* valuable, but if there's a bigger issue that involves this one, the effort will be more efficient there. Just my 2 cents.
Now, this issue is already RTBC, so .. it might be commited if left untouched. Again, for reference, this change wasn't included in the other issue's patch.
Comment #15
webchickI'm ok with committing this little fix by itself, but yeah in general let's do these types of clean-ups in bigger chunks so the needs review/needs work/needs review/needs work/needs review/rtbc can happen fewer times.
Committed and pushed to 8.x and 7.x. Thanks!
Comment #16.0
(not verified) commentedpatch has passed testing